Skip to content

Commit ac8d225

Browse files
Merge branch 'release/0.1.1'
2 parents 9f98d08 + b718cd9 commit ac8d225

File tree

6 files changed

+45
-14
lines changed

6 files changed

+45
-14
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Get Profile – is a personal portfolio template bundle. Here you can find a lot
66

77
<!-- Add a table with 3 columns -->
88

9-
| Template Name | Live Demo | Deployment |
10-
| -------------------------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11-
| [Pofology](./pofology/README.md) | [Live Demo](https://pofology.mostafizur.dev/) | [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmostafizurhimself%2Fgetprofile%2Fpofology) |
9+
| Template Name | Live Demo | Deployment |
10+
| -------------------------------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11+
| [Pofology](./pofology/README.md) | [Live Demo](https://pofology.bdlancers.com/) | [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmostafizurhimself%2Fgetprofile%2Fpofology) |
1212

1313
### Contribution
1414

pofology/.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
NEXT_PUBLIC_API_URL=http://localhost:1337/api
1+
NEXT_PUBLIC_APP_NAME=Pofology

pofology/README.md

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
Pofology – is a personal portfolio template build with Typescript, NextJS and Tailwindcss. This template is designed for building beautiful personal portfolio website. It has a great customisable option. Fully responsive and looks great on any devices. This template contains custom made pages for your portfolios & blog posts. It’s suitable for designers, developers or freelancers who want to show their projects and services, share their thoughts and knowledge with their own platform. Finally it’s a clean & minimal design.
44

5-
Demo live at: [https://pofology.mostafizur.dev/](https://pofology.mostafizur.dev/)
5+
Demo live at: [https://pofology.bdlancers.com/](https://pofology.bdlancers.com/)
66

77
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmostafizurhimself%2Fgetprofile%2Fpofology)
88

9-
### Features
9+
## Features
1010

1111
- Built on Typescript, NextJS and Tailwindcss
1212
- Light & Dark theme support
@@ -19,7 +19,7 @@ Demo live at: [https://pofology.mostafizur.dev/](https://pofology.mostafizur.dev
1919
- Easily Customizable
2020
- Reusable Components
2121

22-
### How to use
22+
## How to use
2323

2424
1. Install NodeJs
2525

@@ -71,9 +71,39 @@ Now you can see the project running on [http://localhost:3000](http://localhost:
7171

7272
_**NB: If you are using npm, then remove the `yarn.lock` file**_
7373

74-
---
75-
76-
#### Screenshots
74+
## Project Structure
75+
76+
There are two main folders `public` & `src` and some other configuration related file in project root.
77+
78+
- public
79+
- fonts → Application fonts
80+
- images → Application Images
81+
- src
82+
- components → Reusable react components
83+
- form → Form related components
84+
- icons → Custom icons components
85+
- partials → Components which are the part of a big layout but not repeatedly used
86+
- shared → Repeatedly used components
87+
- data → Static data for the application
88+
- hooks → Reusable custom react hooks
89+
- layouts → Contains the app base layout
90+
- pages → Here goes available pages for the application
91+
- blog
92+
- [id].tsx
93+
- index.tsx
94+
- works
95+
- [id].tsx
96+
- index.tsx
97+
- \_app.tsx
98+
- contact.tsx
99+
- index.tsx
100+
- styles → Contains application .`scss` files
101+
- modules → Style modules which are directly used in react components
102+
- partials → SCSS partial files
103+
- app.scss → The main SCSS file which is loaded by the application
104+
- types → Type definations for the application
105+
106+
### Screenshots
77107

78108
![Pofology Dark](public/screenshot_01.png)
79109
![Pofology Dark](public/screenshot_02.png)

pofology/src/components/partials/Menu.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ const Menu = () => {
1616
<div className="mx-auto flex h-16 max-w-7xl items-center px-4 md:px-6">
1717
<Link href="/">
1818
<a className="text-3xl font-bold">
19-
<span>Mostafizur</span>
19+
<span>Pofology</span>
2020
<span className="text-primary-500">.</span>
2121
</a>
2222
</Link>
@@ -127,7 +127,7 @@ const Menu = () => {
127127
<div className="border-b px-2 pb-4 dark:border-gray-700">
128128
<Link href="/">
129129
<a className="text-3xl font-bold">
130-
<span>Mostafizur</span>
130+
<span>Pofology</span>
131131
<span className="text-primary-500">.</span>
132132
</a>
133133
</Link>

pofology/src/layouts/AppLayout.tsx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ interface Props {
1111
}
1212

1313
const AppLayout: React.FC<Props> = ({ children, title }) => {
14-
const pageTitle = title ? `${title} | GetProfile` : 'GetProfile';
14+
const appName = process.env.NEXT_PUBLIC_APP_NAME || 'Pofology';
15+
const pageTitle = title ? `${title} - ${appName}` : appName;
1516
return (
1617
<>
1718
<Head>

pofology/tailwind.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ module.exports = {
77
"./src/layouts/**/*.{js,ts,jsx,tsx}",
88
"./src/components/**/*.{js,ts,jsx,tsx}",
99
],
10-
darkMode: 'class',
10+
darkMode: 'media',
1111
theme: {
1212
screens: {
1313
'xs': '475px',

0 commit comments

Comments
 (0)