Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marsidev/overnote
Overnote is a simple notes app. It allows you to create, edit, customize, and delete notes.
https://github.com/marsidev/overnote
bootcamp-project chakra-ui express framer-motion full-stack fullstack-development javascript nodejs notepad notes notes-app react reactjs todo todo-app
Last synced: 15 days ago
JSON representation
Overnote is a simple notes app. It allows you to create, edit, customize, and delete notes.
- Host: GitHub
- URL: https://github.com/marsidev/overnote
- Owner: marsidev
- Created: 2022-01-04T19:28:23.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-29T14:34:12.000Z (over 1 year ago)
- Last Synced: 2024-11-03T05:42:05.450Z (2 months ago)
- Topics: bootcamp-project, chakra-ui, express, framer-motion, full-stack, fullstack-development, javascript, nodejs, notepad, notes, notes-app, react, reactjs, todo, todo-app
- Language: JavaScript
- Homepage: https://overnote.onrender.com
- Size: 1.19 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 
[Overnote](https://radiant-mountain-30055.herokuapp.comm)
***A simple notes app***
Table of Contents
## 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](https://www.youtube.com/watch?v=wTpuKOhGfJE&list=PLV8x_i1fqBw0Kn_fBIZTa3wS_VZAqddX7) directed by [@midudev](https://github.com/midudev/).
The UI is inspired on [Google Keep](https://keep.google.com/), my favorite notes app.
## Getting started
Add the following environment variables to your `.env` file in `/packages/api`:
- `MONGODB_URI=`
- `JWT_SECRET=`
- `JWT_DAYS_TO_EXPIRE=`
Add the following environment variables to your `.env` file in `/packages/app`:
- `SKIP_PREFLIGHT_CHECK=true`
Install dependencies
```javascript
$ yarn
```
Run the app
```javascript
$ yarn build && yarn start
```
Run as development
```javascript
$ 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)
## Built with
- [React](https://reactjs.org/)
- [Webpack](https://webpack.js.org/)
- [Babel](https://babeljs.io/)
- [Chakra UI](https://chakra-ui.com/)
- [React Router v6](https://reacttraining.com/react-router/web/guides/quick-start)
- [Framer Motion](https://framer.com/motion)
- [Node.js](https://nodejs.org/)
- [Express](https://expressjs.com/)
- [MongoDB](https://www.mongodb.com/)
## 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](https://github.com/marsidev/overnote/issues/new).
## Contact
**Luis Marsiglia**
- [Twitter](https://twitter.com/marsidev)
- [Email](mailto:[email protected])