Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zaid-maker/portfolio
https://github.com/zaid-maker/portfolio
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/zaid-maker/portfolio
- Owner: Zaid-maker
- License: mit
- Created: 2023-02-27T09:12:38.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-29T18:29:11.000Z (about 1 year ago)
- Last Synced: 2024-11-09T22:47:37.030Z (2 months ago)
- Language: TypeScript
- Homepage: https://portfolio-devmirza.vercel.app
- Size: 3.55 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Portfolio
## About portfolio
This work is my new portfolio site built with [Next.js](https://nextjs.org/), [TypeScript](https://www.typescriptlang.org/), [Three.js](https://threejs.org/) & [Mantine](https://mantine.dev/). A website presents a single page application with carousel consisting of sections presented in the header.
## Installation
To run this project locally, you need to have [Node.js](https://nodejs.org/en/) installed on your machine:
```bash
git clone https://github.com/Domin-MND/portfolio . # clone the repository into the current directory
npm install # for the dependencies installation
npm run build # for the production build
npm start # start the server
```
else you can deploy it on [Vercel](https://vercel.com/) by using its CLI tool:
```bash
npm i -g vercel # install the Vercel CLI tool
vercel # deploy the project
```
## Configuration
You can configure the project by editing the `config.tsx` files in the following components:
- `components/about/config.tsx` (for the About card)
- `components/contact/config.tsx` (for the Contact card)
- `components/footer/config.tsx` (for the footer component)
- `components/header/config.tsx` (for the header component)
- `components/skills/config.tsx` (for the Skills card)
- `components/works/config.tsx` (for the Works card)
## i18n
This project supports i18n. If no translation is provided to the language - it will take the config information from the above tsx files. The english default translation folder must be named `en` and should never be deleted but may be modified.
## Documentation
All the available documentation regarding the creation & maintainability of the project is in `docs` folder.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## Contributors
Huge thanks to these wonderful people for their contributions:
RaydanOMGr
Translated portfolio to german
Len#2832
Translated portfolio to indonesian
yung_heheh#0430
Translated portfolio to polish & helped with testing the web
djoh
Translated portfolio to ukrainian
> Note: If you wish to help translate the portfolio to your language, please join the [Crowdin project](https://crowdin.com/project/domins-portfolio).
## License
This project is under [MIT](https://choosealicense.com/licenses/mit/) license. You can freely use it for your own purposes.