Before start using this project, please refer to .env.example to check the variables required by the project. The file contains links to the places in which you can get the values.
After updating it, create a copy and name it .env. This file should never be committed to Git, as it contains sensitive data.
Please refer to package.json script list to get in touch with everything that is possible to do.
Netlify supports both deployments triggered by the client (Netlify CLI) or by a merge on main (Github Repository). In this project, I am using the CLI.
The scripts found on /web/scripts/ contain all the relevant NPM scripts required to a successful deployment.
This project is configured to use Cypress for integration tests. There are no unit tests with Jest and no plans to include them, as I believe Cypress is doing a good job at the moment.
- Remix.run
- Tailwind CSS (with Typography Plugin)
- Headless UI and HeroIcons
- Netify
- routes-gen - to bring type-safety to routes
- Plausible Analytics
- Unsplash - for gorgeous images
- Nord Theme - for color inspiration
Please refer to the instructions below. Before running this application for the first time, you should build it with yarn build (or npm run build), otherwise you could get an error. This happens on the very first run only.
- Install the Netlify CLI:
npm i -g netlify-cliIf you have previously installed the Netlify CLI, you should update it to the latest version:
npm i -g netlify-cli@latest- Sign up and log in to Netlify:
netlify login- Create a new site:
netlify initThe Netlify CLI starts your app in development mode, rebuilding assets on file changes.
npm run devOpen up http://localhost:3000, and you should be ready to go!
There are two ways to deploy your app to Netlify, you can either link your app to your git repo and have it auto deploy changes to Netlify, or you can deploy your app manually. If you've followed the setup instructions already, all you need to do is run this:
$ npm run build
# preview deployment
$ netlify deploy
# production deployment
$ netlify deploy --prod