https://github.com/alexisintech/mindfully
A journaling app that promotes mindfulness. Write journal entries every day either by using a blank slate or by using prompts created for you or created by you.
https://github.com/alexisintech/mindfully
bcrypt bootstrap ejs expressjs javascript mongodb mongoose nodejs passportjs
Last synced: 3 months ago
JSON representation
A journaling app that promotes mindfulness. Write journal entries every day either by using a blank slate or by using prompts created for you or created by you.
- Host: GitHub
- URL: https://github.com/alexisintech/mindfully
- Owner: alexisintech
- Created: 2022-10-08T21:23:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-18T02:59:48.000Z (over 3 years ago)
- Last Synced: 2024-05-02T06:15:13.935Z (about 2 years ago)
- Topics: bcrypt, bootstrap, ejs, expressjs, javascript, mongodb, mongoose, nodejs, passportjs
- Language: CSS
- Homepage: https://mindfully.up.railway.app/
- Size: 42.9 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🪐 [Mindfully](https://mindfully.up.railway.app/)
> A full-stack app that encourages users to improve their mental health through mindfulness and journaling.
## ⭐ Features
### Welcome page
- User authentication supported using Passport.js and password encryption using Bcrypt password-hashing
### About page
- Includes information on the extra special features of Mindfully designed to enhance the user experience
### Profile page
- Custom greetings based on time of day and user's name
- Write journal entries every day either by using a blank slate or by using prompts
- The calendar provides monthly overviews for users to be able to view past journal entries
- Randomly generated affirmations and reminders help redirect thoughts and attitudes into positive directions
### Settings
- View all past entries. Click on a specific entry to access its full view.
- View prompts that were created for you or by you. Create custom prompts to help guide your journaling process.
## 🛠️ Built With
- MongoDB, Mongoose.js
- Node.js, Express.js
- Passport.js
- EJS, Bootstrap, HTML5/CSS3
- Javascript ES6
- ESlint, Stylelint
- VSCode
## 🚀 Get your own copy running!
1. Navigate to the folder you would like to store the project
2. Clone the repo
```sh
git clone https://github.com/alexisintech/mindfully.git
```
3. Switch into the directory that was just created
```sh
cd mindfully
```
4. Install NPM packages
```sh
npm install
```
5. Navigate to the config folder
6. Create a .env file there called `.env`
7. Enter your MongoURI string in `.env` with the key `DB_STRING`
```sh
DB_STRING=""
```
8. To run the application, use `npm run start` to run the app in a development environment
The page will reload if you make edits.
You will also see any lint errors in the console.
## 🌠 Roadmap
- [X] Mobile-first design; responsiveness using CSS Flexbox
- [X] Remove redundant bootstrap by using vanilla CSS classes
- [ ] "Choose year and month" prompt before displaying corresponding calendar
- [ ] Refactor calendar
- [ ] Organize all of a user's entries by month and year
See the [open issues](https://github.com/alexisintech/mindfully/issues) for a full list of proposed features (and known issues).
## 🌝 Tea Spill
Coming soon...