Welcome to the Dev Dossier Site project! I've put this together to help others like me explore building their own portfolio. It is built using TypeScript, Node.js, and Three.js for interactive 3D graphics. Additionally, I plan on building more integrations directly into the dossier, including the ability to play chess together :).
-
TypeScript: The project uses TypeScript to ensure type safety and better code quality.
-
Node.js: Node.js is used for server-side scripting and as the backend environment.
-
Three.js: Three.js is a powerful 3D graphics library for creating interactive 3D content in the browser. It is used to add a creative touch to your portfolio.
-
React + Vite: Integrating React with Vite allows this site to provide you with faster development (HMR - Hot Module Replacement) and an improved development experience.
-
Tailwind: A utility-first CSS framework for rapidly building custom user interfaces.
To get started with this project, follow these steps:
-
Clone the repository:
git clone https://github.com/shawilly/dev-dossier.git
-
Install dependencies:
cd dev-dossier npm install -
Start the development server:
npm run dev
-
Open your browser and visit
http://localhost:8080to see the portfolio site in action.
The project is organized as follows:
src/: This directory contains the source code of the project.public/: Public assets like images and static files.
I welcome contributions from the community! If you'd like to contribute to this project, please follow these guidelines:
-
Fork the repository and create your branch from
main. -
Open a pull request with a clear description of your changes and the problem you are solving.
-
Please make sure your code follows the established coding style and passes linting checks.
If you encounter any issues or have suggestions for improvement, please open an issue on GitHub. We appreciate your feedback and contributions.
This project is licensed under the MIT License - see the LICENSE file for details.
We would like to thank the developers of the following Vite plugins for making the integration of React and Vite possible:
Their contributions have helped enhance the development experience for this project.
Happy coding!