This project is setup so that you can build a React frontend with React Bootstrap and React-Router-Dom
- NodeJS (v16), and npm
- React v18
- React Bootstrap
- React-Router-Dom v6
See Environment Setup below for instructions on installing these tools if you don't already have them.
Start by cloning (not forking) the project template repository and removing the remote:
$ git clone git@github.com:wyu6609/website_template.git your-project-name
$ cd your-project-name
$ git remote rm origin
Then, create a new remote repository on GitHub. Head to github.com and click the + icon in the top-right corner and follow the steps to create a new repository. Important: don't check any of the options such as 'Add a README file', 'Add a .gitignore file', etc — since you're importing an existing repository, creating any of those files on GitHub will cause issues.
If you're working with a partner, add them as a collaborator on GitHub. From your repo on GitHub, go to Settings > Manage Access > Invite a collaborator and enter your partner's username. Once your partner has access, they should git clone (not fork) the repository.
Finally, connect the GitHub remote repository to your local repository and push up your code:
$ git remote add origin git@github.com:your-username/your-project-name.git
$ git push -u origin main
When you're ready to start building your project, run:
npm install