https://github.com/ananya2001-an/note

A minimalistic note taking app
https://github.com/ananya2001-an/note

css html javascript mongodb nodejs-server react vercel

Last synced: 27 days ago
JSON representation

A minimalistic note taking app

• Host: GitHub
• URL: https://github.com/ananya2001-an/note
• Owner: Ananya2001-an
• License: mit
• Created: 2023-02-10T09:16:28.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-30T11:16:57.000Z (10 months ago)
• Last Synced: 2024-10-02T15:11:29.510Z (about 2 months ago)
• Topics: css, html, javascript, mongodb, nodejs-server, react, vercel
• Language: JavaScript
• Homepage:
• Size: 499 KB
• Stars: 1
• Watchers: 1
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) 

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/Ananya2001-an/note)](https://github.com/Ananya2001-an/note/releases)

![GitHub repo size](https://img.shields.io/github/repo-size/Ananya2001-an/note)

# This is note.

"**note.**" is a minimalistic note taking app and also allows you (especially students) to keep track of your important assignments.

![note-](https://user-images.githubusercontent.com/55504616/218420244-1b1fa815-8074-44b9-b27c-40b38a034716.png)

## Features

1. You can create, update, view, delete and search your notes and assignments.

2. You can use dark mode for better reading.

3. Site is fully responsive so you can use it on any mobile device.

## Tech stack

- Nodejs

- React

- CSS3

- HTML5

- Express

- MongoDB

- CI/CD with Github Actions

- Docker

### Prequisites for development

- Nodejs

- Git

### Commands

1. Clone your forked repo on your local machine using command `git clone https://github.com/{username}/note.git`

2. Run `npm install` in terminal to install all dependencies mentioned in package.json file.

3. Also create a `.env` file in which you must add the server url. You can refer the `.env.example` file for it.

4. Finally run `npm run start` script to start the app in dev mode. Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.You may also see any lint errors in the console.

## License

note is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.