This is a skeleton for a frontend web application using React. It is intended to be used as a starting point for new projects. It is not intended to be a production-ready application.
-
Fork the repository on GitHub.
-
Clone the repository to your local machine.
git clone <repository-url> <directory-name> # Example: git clone https://github.com/9-5-pursuit/react-skeleton my-app-frontend
-
Change into the directory.
cd <directory-name> # Example: cd my-app-frontend
-
Setup a new remote repository on Github so that you don't overwrite the skeleton repository.
-
Link your local repository to your new remote repository.
git remote set-url origin <new-repository-url>
-
Make a small change, then create a new commit to test the remote repository.
git add . git commit -m "Update remote repository" git push
# Install dependencies
npm install
# Start the development server
npm startNote: You should have the backend development server running before starting the frontend development server. Each server should be running simultaneously in separate terminal windows. This can be a lot to keep track of at first, so take your time when making changes to the repository.
- React - JavaScript library for building user interfaces
- react-router-dom - Routing
- axios - HTTP client
- sass - CSS extension language
- tone.js - Web Audio framework for creating interactive music in the browser
- react-icons - A comprehensive library of popluar icons
- react-burger-menu - A flexible and customizible component that can create various sidebar menu.
- react-avatar - Display a user profile in square or circular picture
- styled-components - A library that allows to write CSS in JavaScript
- validator - A library makes data validation authenticate the user.
- jwt-decode - A JavaScript library that is used to decode JSON Web Tokens.
Since this is a skeleton, the .env file is included in the repository. This is not recommended for production applications. The .env file should be added to the .gitignore file and the environment variables should be set in the production environment.