# Vitalize (Backend/API)


Vitalize is a mental health and wellness app tailored to healthcare professionals. This repo contains the API that is used to store user data.

**Our group currently is running the API on a Heroku server that can be found [here](https://vitalize-api.herokuapp.com/ ).**


## Architecture

### Tools and Libraries Used

[Express](https://expressjs.com/) was a web framework that we used to listen for and respond to incoming web requests. Express allowed us to create API endpoints to respond to the CRUD-style requests that our app will be making.

[Mongo](https://www.mongodb.com/) was used as our database to store and manage the data for our app. To connect to mongo in our app, we used the [mongoose](https://mongoosejs.com/) module. Mongoose allows us to create schemas for our objects in order to validate and assert our data before inserting it into the mongo database.

[Passport](https://www.passportjs.org/) was a npm module that was used for authentication services. This module allowed us to handle log in/log out for the different users that will be using our app.

The [CS 52 starter express app template](https://github.com/dartmouth-cs52/express-babel-starter) was used as a starting base for building this repo.

### Code Organization

Please check out the [src directory](https://github.com/dartmouth-cs52-21S/project-api-vitalize/tree/master/src) to find the specific code written for this project.

#### Services
Currently, this subdirectory contains our code that uses the Passport module to handle authentication. The password+username strategy we are using is defined here.

#### Models
The schemas for the objects used to store our data is specifed here.

**Current List of Models:**
* **user_model** - stores user info (username/password)
* **stats_model** - stores meditation and journaling stats of the user
* **post_model** - stores info for the individual posts/journal entries made by the user

#### Controllers
This subdirectory contains the methods that perform all the main functionality of our API. These methods handle the CRUD-style requests that will be made on the models that we have created.

## Setup

Clone the repo and run:

npm install
npm start

This will allow you to host the API server on a local domain.

Our group currently is running the API on a Heroku server that can be found [here](https://vitalize-api.herokuapp.com/ ). Details on how we deployed on Heroku is found below.

## Deployment

1. Go to [Heroku](https://www.heroku.com/) and and login or sign up. Create a new app for this project.
2. Go to the Deploy tab and connect to your GitHub
a. We strongly reccomend turning on Automatic Deploys so that any time you make edits they will be reflected in your app.
3. Go to [MongoDB Atlas](https://www.mongodb.com/cloud/atlas1) and create an account. We reccomend creating a free account.
4. Once you have created your cluster, click on the 'Database Access' tab and create an access username and password. Make sure to save them!
5. Click on network access and allow access from anywhere.
6. Then, click on clusters, then connect, then connect you application and copy the connection string
a. Don't forget to replace <password> with your actual password from before

To connect your Heroku and Mongo database:
1. Go to your mongo database and click on settings, then reveal congif vars
2. Add the key: MONGODB_URI
3. Add your connecetion string from earlier

To test:
Click on Open App at the top right of Heroku

## Authors

**Vitalize Backend Team:**

- Anna Martin
- Jason Pak
- Seungjae Lee

**Other Vitalize Team Members:**

- Michelle Chen
- Charlie Nee
- Vi Tran

## Acknowledgments

The following Dartmouth CS52 Short Assignments and Labs were our main guides in developing the backend for our project:

* [Server-side Rendering](https://cs52.me/assignments/sa/server-side/)
* [Authentication](https://cs52.me/assignments/sa/authentication/)
* [Platform: Server](https://cs52.me/assignments/lab/redux-platform+server/)