Skip to content

Latest commit

 

History

History
178 lines (127 loc) · 14.5 KB

README.md

File metadata and controls

178 lines (127 loc) · 14.5 KB
Raw

staging

FightPandemics.com Overview

Currently, there is no easy way to match all that are in need with those that are providing help, at the same time is difficult to find all the information at the local and global level of the different initiatives, projects, researchers, donors, investors, FREE or discounted tools for builders, the grants available and other relevant information. That's why Fight Pandemics was born.

Please check our notion to get a better understanding of the problem that we are trying to solve: https://www.notion.so/fightpandemics/FightPandemics-Overview-cd01dcfc05f24312ac454ac94a37eb5e

Technologies

Before getting started please be familiar with the stack below. Additionally it is important to understand basic Git and Github for smooth collaboration as a team.

  • Frontend
    • React Hooks, Ant Design, Ant Design Mobile, styled-components
  • Backend
    • Fastify, MongoDB, Mongoose
    • Auth0, Google Maps API
  • DevOps
    • Docker, Terraform, Nginx, AWS

Project Setup

  1. Fork or Clone this repository
  2. There are two ways to set up the app: Docker or Local Setup. It is strongly recommended to use the Docker Setup, but if you are unable to install Docker, you have the option of setting up the app locally.

If, at any point, you are having trouble setting up the app, please use Slack's search bar to search for exisiting questions. Also do not hesitate to ask us for assistance in the #engineering Slack channel! In order to speed up assistance, please mention the method that you are using to set up the app, as well as the operating system that you are using.

Docker Setup

  1. Follow the steps for your OS to install Docker and Docker Compose. Note that depending on the Docker install, Docker Compose may already be included, so it would not be necessary to install Docker Compose separately.
  2. Copy client/.env.example to client/.env
  3. Copy backend/.env.example_docker to backend/.env
  4. Replace TODO entries in both .env files with correct values (this is not needed to run the project in a responding but non-functional state).
    • For AIRTABLE and AUTH variable values, either use Slack's search bar to search for exisiting requests, ask in the #engineering Slack channel, or consult the non-engineer guide.
  5. Run docker-compose up this will take quite some time. (Starting the development server... is not the final line).
  6. Finally, navigate to localhost:3000 in your browser - the page title should be "Fight Pandemics" and you should see a styled page.
  7. To import posts data from Airtable run docker-compose exec backend-service npm run import-posts. By default 100 records are returned. To get a specific number of records pass a numeric argument, e.g. docker-compose exec backend-service npm run import-posts -- 10. Use -1 to get all records (~2500 as of this writing).

Local Setup

If, for some reason, you are unable to use Docker, you can still set up the app locally. Note that you can set up each of these three services separately, but some functionality may not work. For example, if only the client is running, none of the calls to the backend or geo-service service will work. If only the backend is running, none of the calls to the geo-service will work.

MongoDB

Follow the MongoDB installation instructions for your operating system.

Client

  1. Install nvm (for Mac/Linux), or nvm-windows (for Windows).
  2. Using nvm, install Node 12.16.2: nvm install 12.16.2.
  3. Enter the client directory and run npm install.
  4. Copy the .env.example in the client directory to .env.
  5. Replace TODO entries in client/.env with correct values (this is not needed to run the project in a responding but non-functional state).
    • For AIRTABLE variable values, either use Slack's search bar to search for exisiting requests, ask in the #engineering Slack channel, or consult the non-engineer guide.
  6. Start the client app by running npm start, and wait for the app to start up. (Starting the development server... is not the final line).
  7. Finally, navigate to localhost:3000 in your browser - the page title should be "Fight Pandemics" and you should see a styled page.

Backend

  1. If not already installed, install MongoDB.
  2. If not already installed, install nvm and Node 12.16.2 (see steps 1 and 2 in the Client section above).
  3. Enter the backend directory and run npm install.
  4. Copy the .env.example_local in the backend directory to .env.
  5. Replace TODO entries in backend/.env with correct values (this is not needed to run the project in a responding but non-functional state).
    • For AUTH variable values, either use Slack's search bar to search for exisiting requests, ask in the #engineering Slack channel, or consult the non-engineer guide.
  6. Start the backend server by running npm start. NOTE: If you want the server to automatically restart on code changes, run npm run dev instead.
  7. The backend can be accessed at localhost:8000 using cURL, Postman, or a similar API testing tool.
  8. To import posts data from Airtable, from the backend directory, run npm run import-posts. By default 100 records are returned. To get a specific number of records pass a numeric argument, e.g. npm run import-posts -- 10. Use -1 to get all records (~2500 as of this writing).

Geo Service

  1. Install pyenv (for Max/Linux) or pyenv-win (for Windows).
  2. Using pyenv, install Python 3.7.6: pyenv install 3.7.6
  3. Enter the geo-service folder, and create a virtual environment: python -m venv venv.
  4. Activate the virtual environment: . venv/bin/activate (Mac/Linux); venv\Scripts\activate.bat (Windows CMD); venv\Scripts\Activate.ps1 (Windows PowerShell).
  5. Run pip install -r requirements.txt to install dependencies.
  6. Start the geo-service by running python app.py
  7. The geo-service can be accessed at localhost:5000 using cURL, Postman, or a similar API testing tool.

Contributing

Check the issues and projects tab of the original repository for available tickets. Please follow our instructions on how to properly open an issue and make pull requests to our repo.

Additionally please review the "Important Notes and Considerations" section in this README.

Time sensitive issues

Due to the importance of what we are trying to accomplish and the fact that some features are critical for certain releases, sometimes issues need to be completed within a specfic timeframe. In order to ensure that this can happen, it is very important that you communicate your progress with the team in either the engineering or general standups. Please also try and push your code to GitHub every day that you work on an issue.

In the event that there is an upcoming deadline for a particular feature, someone from the team may try and contact you to see what the current status is and if you possibly need help with the task. If we don't hear anything from you after 48 hours, another engineer might have to take over the issue and it will be re-assigned on GitHub. Therefore it is CRITICAL that you have your current code pushed to GitHub so that others can possibly use your work as a reference to ensure the issue gets completed as quickly as possible.

API Documentation

To check the API documentation which is automatically generated using fastify-oas , go to http://localhost:8000/documentation

Adding NPM dependencies to package.json

Note that whenever you add a new NPM dependency, you must run npm install from within the container. This is because NPM dependency installs may not necessarily be cross-platform. There are two ways that you can install the dependencies within the container:

Backend

Run docker-compose run backend-service npm install, or cd into the backend directory and run npm run install-docker.

Client

Run docker-compose run client npm install, or cd into the client directory and run npm run install-docker.

Be sure to also commit any changes to the package-lock.json so that dependencies used by third-parties are also locked to specific versions.

Important Notes and Considerations

We are noting any special considerations and handling done in the code so that developers are aware of these caveats while developing. This is a living document, so feel free to add any notes that you feel are worth mentioning here.

Development Workflow

We collaborate closely with the design and product team. The design team provides us with designs of the application on Figma. While the product team provides us with MVP requirements on Notion.

  • Please be sure to often merge or rebase the latest from the master branch into your feature/working branches to minimize merge conflicts and so that it doesn't fall too far behind master.
  • If possible, try to keep changes in pull requests small so that it'll be faster for reviewers to review and easier for contributors to make revisions. If you foresee there will be many changes, make sure to commit often. This will help break down a pull request more easily.

Backend

  • API requests are validated using Ajv and JSON schema's are defined with FluentSchema
    • By default, the schema's allow additional properties unless explicitly set that additional properties are not allowed. There's a utility function strictSchema() in lib/endpoints/schemas/utils.js that can be used to initialize all schema's.
    • Rather than silently suppress additional properties, as is the default behavior for Fastify's ajv configuration, we are instead returning a 400 bad request error if additional properties are passed in. This makes it easier to debug issues due to a misspelled property name.
    • Read more about validation in Fastify in the docs https://www.fastify.io/docs/v2.2.x/Validation-and-Serialization/#validation
  • Endpoint handlers should use async functions, and return values or throw httpErrors.

Frontend

  • We have the beginnings of a theme. The file can be found here: src/constants/theme.js which has sections for typography, colors, buttons styles and media queries.
    • Limit the use of inline styling.
    • Limit the use of px values, currently the root font size is 62.5%, 1rem = 10px
    • No use of .css or .scss files, please style with styled-components instead.
  • Use assets such as icons from the designs on Figma
    • Select the screen that you are going to design
    • On the left side of Figma, unlock the screen (Only the one that you are going to use)
    • Select an icon or component -> right click -> Copy/Paste -> Copy as CSS/SVG
    • You can also get exact CSS values on the top right of Figma
    • After you are done with your screen, lock it again!!
  • Use absolute imports. We have a resolved path of client/src. For example, import like this: import Button from "components/Button", rather than import Button from "../../components/Button.
  • For most components, we can use components from Ant Design and override styling where needed. Please refrain from reinventing the wheel. 
        import styled from "styled-components";
    import { Button } from "antd";

    const StyledButton = styled(Button)`
        // target antd selectors and override styles here
    `;
  • For new pages, create a new route in client/src/routes.js and import a page component from client/src/pages
  • Refrain from making the Redux state too big as it will affect speed performance. React’s Context API is ONLY helpful for avoiding nested prop threading so stick with Redux where Context fails.

Deployment

Review branches

Every time you push code up to this repository on a branch with the feature/ prefix, a review build based off of your feature branch will be deployed to AWS. For the build to deploy successfully you must be a member of this organization (ask in Slack) and push to this repo. Pull requests are still welcome from forked repos, just omit the feature/ prefix to skip this build step.

You can view the build logs in GitHub Actions. After the build successfully completes, you can view the URL to which your app was deployed by clicking on the "Deployment URL" step in the deploy_review job in the workflow run for your build:

Deployment URL

Note that it may take a few minutes for the app to be accessible, or for changes to be reflected, since it takes time for AWS to spin up the Docker containers.

Staging

When a pull request is merged to master, it will automatically be deployed to the staging environment. You can view the build logs in GitHub Actions. After the build successfully completes, wait a few minutes for the changes to be reflected, and then access the staging app at http://staging.fightpandemics.work.

Production

Coming soon...