Good Deeds Data - Admin Web Portal

Setup

• Install Node 14+

• Download yarn

• Setup your local yarn workspace, Instructions can be found here

• Along with this repo you'll also need to include the following 2 repos in your workspace:

  • gdd-components
  • gdd-api-lib

Development

yarn start - start app in development mode, start dev server, listens and reload on change

Environment Variables

🚨 The end product of this repo is static html/css/js/images, DO NOT put any secrets into any .env file 🚨

Read more about how create-react-app handles env variables here

use .env.development.local or .env.local to override what's in .env. (more info)

CSS

When necessary, global styles go in src/styles/global.scss

Use CSS Modules in your components using the same component name:
Component: SomeThing.js
CSS Module: SomeThing.module.css

We're using React-Bootstrap & Bootstrap 4.5
https://react-bootstrap.github.io/
https://getbootstrap.com/

JS

The project has absolute imports set up to ./src so you can import files easier and it makes import statements easier to copy and paste between files

// ok
import './components/Header';
import '../../utils/my-utils';
import './Header.module.scss';

// better
import 'components/Header';
import 'utils/my-utils';
import 'components/Header.module.scss';

---

This project was bootstrapped with Create React App.