Skip to content
This repository has been archived by the owner on May 23, 2023. It is now read-only.

Latest commit

 

History

History
44 lines (33 loc) · 2.67 KB

README.md

File metadata and controls

44 lines (33 loc) · 2.67 KB

CircleCI CircleCI Maintainability Quality Gate Status License: AGPL v3

What VIRA?

This tool allows you to easily generate reports on the basis of projects that have been co-funded by your foundation. After signing in, access is granted to project information and the progress can be reported. These reports allow your foundation to monitor the effectiveness of contributions more effectively.

About the project

Installing

1. Set up the VIRA-frontend first
2. Checkout this repository to a local folder
3. Make sure you've installed node.js 10.16.3 or higher
4. Run yarn install
5. Create an .env file and specify the following variables:

  • REACT_APP_PROJECT_URL=http://localhost:3000
  • REACT_APP_AUTH_CUSTOM_DOMAIN=<REACT_APP_AUTH_CUSTOM_DOMAIN>
  • REACT_APP_AUTH_DOMAIN=<REACT_APP_AUTH_DOMAIN>
  • REACT_APP_CLIENT_ID=<REACT_APP_CLIENT_ID>
  • REACT_APP_AE_API_CLIENT_ID=<REACT_APP_AE_API_CLIENT_ID>
  • REACT_APP_AE_API_CLIENT_SECRET=<REACT_APP_AE_API_CLIENT_SECRET>
  • REACT_APP_AE_API_URL=<REACT_APP_AE_API_URL>

Running the application

To be able to properly run the application you will need to set the following environment variables

  • REACT_APP_BACKEND_PORT=<REACT_APP_BACKEND_PORT>
  • REACT_APP_PROJECT_URL=<REACT_APP_PROJECT_URL>
  • REACT_APP_BACKEND_URL=<REACT_APP_BACKEND_URL>
  • REACT_APP_MONGO_DB_URL=<REACT_APP_MONGO_DB_URL>

After you've correctly set the enviroment variables you can run yarn start