Software Developer Portfolio Template in React with TypeScript following best practices: Unit and end-to-end tests, Continuous Integration, and linting.
This is a complete customizable template which lets you showcase your work, education and experience about you as Software Developer.
Stars are welcome 😊
- Home
- Education
- Experience
- Projects
- Contact
-
Create your project based on this template:
- a) If you want to create a GitHub repository, we would recommend to use the GitHub "Use this template" button and clone your newly created repository
- b) If you prefer to just create a local project, you can use degit:
npx degit repo-url my-app
-
Update your project meta-information:
- Update the
package.json:- Specify proper values for the
name,authorandlicenseproperties - Remove the
privateproperty if you plan to publish the app as a npm package
- Specify proper values for the
- Change the author in
LICENSE - Change the title in
index.html - Replace the favicon in the
publicdirectory
- Update the
-
Run your app:
cd my-app: Move to your project root directorynpm install: Install all the project dependenciesnpm start: Start the development server on localhost:3000
npm run test: Run unit tests with Jest and React Testing Library
npm start: Start the development server on localhost:3000- Run end-to-end tests with Cypress choosing one of the following options:
npm run cy:open: Open Cypress in dev modenpm run cy:run: Execute Cypress in CLI
npm run lint: Run linternpm run lint:fix: Fix lint issues
- TypeScript
- ESLint and Prettier
- Jest with React Testing Library for the unit tests
- Cypress with Testing Library for the end-to-end tests
- GitHub Action Workflows set up to run tests and linting on push
- Makefile for standardize how to run projects
- Sass to supercharge CSS with nested classes and more fun
- .editorconfig for sharing the IDE config
Based on https://github.com/harikanani/harikanani.github.io Illustrations: https://undraw.co/
