Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/empobla/codernotes
Coder Notes is a website which allows you to take notes online and save them.
https://github.com/empobla/codernotes
express mongodb nodejs pug
Last synced: about 1 month ago
JSON representation
Coder Notes is a website which allows you to take notes online and save them.
- Host: GitHub
- URL: https://github.com/empobla/codernotes
- Owner: empobla
- License: mit
- Created: 2021-06-02T04:57:32.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-26T09:56:10.000Z (almost 2 years ago)
- Last Synced: 2023-02-26T17:25:29.812Z (almost 2 years ago)
- Topics: express, mongodb, nodejs, pug
- Language: JavaScript
- Homepage:
- Size: 165 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Coder Notes
Coder Notes is a website which allows you to take notes online and save them.
Report Bug
·
Request Feature
Table of Contents
## About The Project
![Coder Notes Screen Shot][product-screenshot]
Coder Notes is a website which allows you to quickly take notes online and save them, having access to the notes quickly anywhere in the world.
### Built With
[![MongoDB][MongoDB]][Mongo-url]
[![Express][Express.js]][Express-url]
[![Pug][Pug.js]][Pug-url]
[![Node][Node.js]][Node-url]
[![Heroku][Heroku]][Heroku-url]
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
This project requires Node.js and local MongoDB. A MongoDB server must be set up locally before using this project.
* Install npm:
```sh
npm install npm@latest -g
```
* Install [MongoDB Community Server][MongoDB-community-url]. Instructions for MongoDB Community Server can be found [here][MongoDB-instructions-url].
### Installation
1. Clone the repo
```sh
git clone https://github.com/empobla/CoderNotes.git
```
2. Install NPM packages
```sh
npm install
```
3. Start the server in development mode!
```sh
npm run devstart
```
## Usage
To write a note, simply start writing!
You can also view your notes, edit existing ones, create new notes, and even delete your notes!
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. 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 with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
Emilio Popovits Blake - [Contact](https://emilioppv.com/contact)
Project Link: [https://github.com/empobla/CoderNotes](https://github.com/empobla/CoderNotes)
[contributors-shield]: https://img.shields.io/github/contributors/empobla/CoderNotes.svg?style=for-the-badge
[contributors-url]: https://github.com/empobla/CoderNotes/graphs/contributors
[issues-shield]: https://img.shields.io/github/issues/empobla/CoderNotes.svg?style=for-the-badge
[issues-url]: https://github.com/empobla/CoderNotes/issues
[license-shield]: https://img.shields.io/github/license/empobla/CoderNotes?style=for-the-badge
[license-url]: https://github.com/empobla/CoderNotes/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/emilio-popovits
[product-screenshot]: README/images/main.png
[MongoDB]: https://img.shields.io/badge/mongodb-ffffff?style=for-the-badge&logo=mongodb&logoColor=47a248
[Mongo-url]: https://www.mongodb.com/
[Express.js]: https://img.shields.io/badge/express-000000?style=for-the-badge&logo=express&logoColor=ffffff
[Express-url]: https://expressjs.com/
[Pug.js]: https://img.shields.io/badge/pug.js-a86454?style=for-the-badge&logo=pug&logoColor=000000
[Pug-url]: https://pugjs.org
[Node.js]: https://img.shields.io/badge/node.js-090c15?style=for-the-badge&logo=nodedotjs&logoColor=339933
[Node-url]: https://nodejs.org
[Heroku]: https://img.shields.io/badge/heroku-430098?style=for-the-badge&logo=heroku&logoColor=ffffff
[Heroku-url]: https://www.heroku.com/
[MongoDB-community-url]: https://www.mongodb.com/try/download/community
[MongoDB-atlas-url]: https://www.mongodb.com/atlas/database
[MongoDB-instructions-url]: https://www.mongodb.com/docs/manual/administration/install-community
[IAM-instructions-url]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html