Skip to content

SchoolOfCode/w9_frontend-project-mindactivity

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 

Repository files navigation




List of Contents

  1. Introduction
  2. Features
  3. Getting Started
  4. Tech Stack
  5. Color Reference
  6. Running Tests
  7. Authors
  8. Appendix



Mindactivity App For Managing Stress🧘

Welcome to Mindactivity!

Just in case you were curious about the name, mindfulness + productivity = mindactivity.

It's a Mindfullness App designed to manage stress levels and increase productivity using meditative media.

This documentation is for the entire Mindactivity app. If you're interested in the backend/API specifically, go to backend repository




Features🎩

  • Timer for meditation or exercise.
  • Music button playing calming nature sounds.
  • Daily affirmations randomised and displayed from database.
  • Blog posts also randomised and displayed from database.
  • Click- and hover-interactive background simulating a night sky.



Getting Started🏁

Backend

*It is important to get the backend working before you run the frontend in order to use the affirmations and the blog post features

  1. Git clone the backend repository.
  git clone https://github.com/SchoolOfCode/w9_backend-project-mindactivity
  1. Install all the dependencies by running this command:
  npm i
  1. Copy your database (e.g. Heroku) URL into the .env file, following the format:
 DATABASE_URL = <Database URL goes here>
  1. Create the table in your database by running this script in the terminal:
npm run db:createTable
  1. Populate the table you have just created by running this script in the terminal:
npm run db:populateTable
  1. Run the server with this command in the terminal:
  npm run dev

Frontend

  1. Git clone the frontend repository.
  git clone https://github.com/SchoolOfCode/w9_backend-project-mindactivity
  1. Install the dependencies by running this command in the terminal.
  npm i
  1. Navigate to this folder w9_frontend-project-mindactivity/Mindactivity

  2. Start the app.

  npm start



Client: React, CSS, Howler, React-tsparticles
Server: Node, Express, PostreSQL
Client-side Testing: React Testing Library
Server-side Testing: Supertest, Jest




Color Reference🎨

Color Hex
Xiketic #131224 #131224
Oxford Blue #F8F8F8 #0C1445
Liberty #00B48A #5C54A4
Rhythm #00D1A0 #8380A4
Melon #00D1A0 #FFB7A2E8
Puce #C3809A #C3809A
Sandy Brown #FBA55A #FBA55A



Running Tests🃏

To run tests, run the following command

  npm test



Authors📚

We are four bootcampers at The School Of Code who teamed up to build an app to help solve bootcamper burnout problem for our mid-course project.




Appendix📝


About

w9_frontend-project-mindactivity created by GitHub Classroom

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •