True Relief

True Relief is a web app that provides tools and strategies to help people who live with cronical pain to better manage their condition. Some of the modules we want to develop are: a. Pain and trigger tracking b. Personalized plan c. Journal d. Daily Tips e. Locate providers in your area that can help you better manager pain

Development Notes

This project was bootstrapped with Create React App. The project uses the Firebase Realtime Database as a backend, so it requires no server-side code or SQL queries.

To build the application

The first step is to clone this repository in your local machine and then, open a terminal and cd into the project directory

1. run npm install

This command will install all the necessary dependencies. Material-ui, firebase and ramda are some of them.

The file package.json contains the complete list of dependencies for this project.

2. Create a project in Firebase

In order to try this app you may create a new project in the Firebase Console. You can create a free account (here) [https://console.firebase.google.com/]

3. Enable Email/Password as authentication method in your Firebase project

This step is important in order to be able to allow authentication in your Firebase project and try the functionality.

To enable Email/Password as authentication method in your Firebase project:

• Go to the Firebase console, open the Auth section.
• On the Sign in method tab, enable the Email/password sign-in method and click Save.

4. Set the environment variables

Once you have created your project in Firebase, create manually the file .env.production in the root of your project. Type the keys generated to connect to your database as follow:

REACT_APP_API_KEY = "your-api-key"

REACT_APP_AUTH_DOMAIN = "your-auth-domain"

REACT_APP_DATABASE_URL = "your-database-url"

REACT_APP_PROJECT_ID = "your-project-id"

REACT_APP_STORAGE_BUCKET = "your-storage-bucket"

REACT_APP_MESSAGING_SENDER_ID = "your-messaging-sender-id"

5. Run npm start

This command runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

6. Run npm run build

This command builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

Contributors

• Perla Jarillo
• Fabiola Vieyra

Contributor Guidelines

If you're looking for a place to start contributing code, check out this list of issues that are ready for someone to pick up and start on. The process to contribute in this repository is:

1. Comment on the issue that you're going to be working on it. This will help us to avoid work duplication.
2. Fork the repository.
3. Start coding.
4. Make a PR when you are ready.
5. A member of True-Relief app will review your contribution and ask for any necessary changes and/or approve and merge.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.