node@v16.15.0 or higher
npm@8.5.5 or higher
git@2.34.1 or higher
-
Copy the
.env.example
file to a.env
file and fill in the environment variables from your Firebase app. -
install dependencies
$ npm install
- Start it up
$ npm start
You can deploy the project on gh-pages or any other hosting service.
To deploy on gh-pages, first change the "homepage" in the package.json
file and set the path to your project on GitHub Pages or your custom domain.
{
"homepage": "https://your-username.github.io/global-notes-v2.0"
}
Save your changes, make the commit, push to your main branch, and then run the command npm run deploy
in your terminal.
$ npm run deploy
React
Gh-pages
React-icons
styled-components
Contributions are welcome! Here are some ways you can contribute:
- Submit bugs and feature requests by opening an issue.
- Improve the documentation by opening a pull request.
- Add a new feature or fix a bug by opening a pull request.