Welcome to Mindactivity!
Mindactivity (Mindfulness + Activity) is a meditative media app which allows users to time their meditation and deep work sessions. Here's a little demo of the app:
Mindactivity.-.25.August.2022.mp4
This documentation is for the entire Mindactivity app. If you're interested in the backend/API specifically, go to my fork of the backend repository
This is a fork of the Mindactivity frontend repo. Original repos can be found here: frontend & backend. All links from this point onward point to the original repos.
- 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.
*It is important to get the backend working before you run the frontend in order to use the affirmations and the blog post features
- Fork the original backend repository. You can find it here.
- Clone the forked repo to your computer. Unless you renamed the repo whilst forking, the command is (insert your GitHub username where indicated):
git clone https://github.com/<YOUR_GITHUB_USERNAME>/w9_backend-project-mindactivity- Install all the dependencies:
npm i- Copy your database (e.g. Heroku) URL into the .env file, following the format:
DATABASE_URL = <Database URL goes here>- Create the affirmations table in your database by running this script in the terminal:
npm run db:createAffirmationsTable- Populate the affrimations table you have just created with data from "/lib/affirmationData.js" by running this script in the terminal:
npm run db:populateAffirmationsTable
- Now, repeat the last 2 steps for blog table. First create it...:
npm run db:createBlogTable- ...then populate it with data from "/lib/blogs.js":
db:populateBlogTable- Finally, run the server:
npm run dev- For the original frontend repo. You can find it here
- Unless you have renamed the repo when you forked it, you can clone it with this command (insert your GitHub username where indicated)
git clone https://github.com/<YOUR_GITHUB_USERNAME>/w9_backend-project-mindactivity- Install the dependencies by running this command in the terminal.
npm i-
Navigate to this folder: w9_frontend-project-mindactivity/Mindactivity
-
Start the app.
npm startClient: React, CSS, Howler, React-tsparticles
Server: Node, Express, PostreSQL
Client-side Testing: React Testing Library
Server-side Testing: Supertest, Jest
To run tests, run the following command
npm testWe 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.