An opinionated starting point for web applications.
- React, Redux, React Router
- Firebase
- Real-time and Firestore databases
- Serverless hosting using Cloud Functions
- SSR (Node, Express)
- Requires NodeJS
>= 10. NVM is recommended. npm install -g firebase-toolsgit clone git@github.com:yawnch/supernova.gitnpm install
All important tasks are executed using NPM scripts. Checkout package.json for a complete list. The most important scripts are detailed here.
Copy .env.example found in 'config' for each required environment:
cp .env.example .env.development
cp .env.example .env.staging
cp .env.example .env.production
If you don't have a Firebase project, get started by creating one here. The config values can be found in your project settings: https://console.firebase.google.com/project/your-project
Builds the app in development mode (using Webpack) and starts a local dev server. Keeps Webpack running in watchmode and updates the app automatically using HMR.
Starts nodemon with the --inspect flag, allowing developers to debug the server logs using the Chrome Dev Tools (Navigate Chrome to **chrome://inspect).
Creates a new production build and deploys it to Firebase Cloud Functions.
npm run deploy:development
npm run deploy:staging
npm run deploy:production
Storybook is an open source tool for developing UI components in isolation
npm run storybook
You can use Plop to scaffold new components automatically.
npx plop Component
npx plop Page
Coding style is enforced using ESLint. You can also manually run the linter using npm run lint:fix.