marsidev / overnote

Overnote is a simple notes app. It allows you to create, edit, customize, and delete notes.

Overnote

A simple notes app

Table of Contents

• About the project
• Getting started
• Built with
• Contributing
• Contact

About the project

Overnote is a simple notes app. It allows you to create, edit, customize and delete notes. This project is a result of a FullStack Bootcamp directed by @midudev. The UI is inspired on Google Keep, my favorite notes app.

Back to top 🔼

Getting started

Add the following environment variables to your .env file in /packages/api:

• MONGODB_URI=<your-mongodb-uri>
• JWT_SECRET=<your-jwt-secret>
• JWT_DAYS_TO_EXPIRE=<your-jwt-days-to-expire>

Add the following environment variables to your .env file in /packages/app:

• SKIP_PREFLIGHT_CHECK=true

Install dependencies

$ yarn

Run the app

$ yarn build && yarn start

Run as development

$ yarn build && yarn dev

Open the app in your browser (http://localhost:8888)

Note that this is a mono-repo project, so you need to build the app before running it because the build folder is served by the api server.

Alternatively, you can run the app and the api server separately with the following:

• Execute in terminal 1: $ yarn run dev
• Execute in terminal 2: $ yarn run start:app
• Open the app in your browser (http://localhost:3000)

Back to top 🔼

Built with

• React
• Webpack
• Babel
• Chakra UI
• React Router v6
• Framer Motion
• Node.js
• Express
• MongoDB

Back to top 🔼

Contributing

Any contributions you make are greatly appreciated. If you have a suggestion that would make this better, please fork the repo and create a Pull Request. You can also simply open an issue.

Back to top 🔼

Contact

Luis Marsiglia

• Twitter
• Email

Back to top 🔼