Myriad

An express-sequelize-passport app that allows the user to track certain symptoms for trending.

Table of Contents

• Installation
• Usage
• Contributing
• Tests
• Questions
• Credits
• License

Installation

If you want to set up your own instance of this app, please follow the following steps.

1. clone this repository using either ssh...

git clone git@github.com:diuguide/symptom_tracker.git

...or clone using https.

git clone https://github.com/diuguide/symptom_tracker.git

2. run npm i in the cloned repository's root directory to install the node module dependencies.

3. In the config.json file, update the "development" password & database name to match your local mysql server information. You may need to create your database if this is the first time setting up a local instance of this app, in which case, make sure the database name you create matches the one you add to the config.json file.

4. Start the server by running node server.js or nodemon server.js. If everything worked correctly, you should be able to see the landing page when navigating to localhost:8080.

back to Table of Contents

Usage

To use the app, navigate to https://symptomtracker2.herokuapp.com/ please follow the following steps.

1. Create an account with your email and a strong password on the signup form. You will be automatically redirected to the user homepage upon account creation.

2. Click the Daily Check-In link and fill out the form to submit your first day of symptom data. You can update the data entered by simply filling out the form and resubmitting.

3. Click the Export Data link to download a copy of all your submitted data to a csv file.

4. Any data you have provided over the past 7 days will be displayed to you in a convenient table below the maroon jumbotron. A cyan block indicates you reported having that symptom on that day. Click the Note button to see that day's note in a modal.

5. Click the Logout link to logout of the app and be returned to the landing page.

6. To log back in, simply enter the information on the login form you provided during signup to access your account again.

back to Table of Contents

Contributing

Your contribution is most welcome! Please refer to the contributing guidelines when making contributions to this project.

Please note that this project is released with a Contributor Code of Conduct. By Participating in this project, you agree to abide by its terms.

back to Table of Contents

Tests

npm test performs ESlint to ensure our coding best practices are followed.

back to Table of Contents

Questions

Please direct any and all questions to any of the contributors of this project.

back to Table of Contents

Contributors

• diuguide
• thadkingcole
• summerhealey

back to Table of Contents

License

MIT copyright (c) 2020 Everett Diuguid, Thaddeus Cole, Summer Healey.

back to Table of Contents