charlestietjen / Trilogy-Group-Project-2-SpacedOut

0 stars 2 forks source link

spacedout

'spacedout' aims to be a mental health anti-social social media web app.

A general idea of the project can be surmised by the user story:

As a user I can:

The idea behind space your problems is not to replace therapy or other professional assistance services. The space the app is envisioned to occupy is one of a sort of catharsis tool, a user may vent/be vulernable in a safe environment and have the opportunity to feel validated as well.

Authors

MIT

Screenshots

App Screenshot

Deployed Application

Deployed spacedout

Installation

To install the application locally, run:

'npm i'

This will install all dependencies required to run the application.

Required modules can be reviewed in the package.json.

Environment Variables

To run this project, you will need to add the following environment variables to an .env file in the root of the application:

DB_NAME='spacedout_db' DB_USER='root' DB_PW='password' SECRET='asecret' API_KEY='secretkey'

Where DB_NAME is an existing SQL database and user/password are valid SQL credentials. SECRET and API_KEY are non-optional but can be set to any value.

Run Locally

Lastly run the server with:

npm start

Navigate to either http://localhost:3001/ if running locally, or the domain and port the application is listening on.

Roadmap