Skip to content

Commit

Permalink
readme Documentation added
Browse files Browse the repository at this point in the history
  • Loading branch information
t007rushi committed Apr 7, 2022
1 parent 3f08c4c commit 4e392e5
Showing 1 changed file with 83 additions and 2 deletions.
85 changes: 83 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,83 @@
# Monkeep
Notes App Mini Project
# [Monkeep](https://monkeep.netlify.app/)📝
Notes App Mini Project Build with REACT

## Live preview Link

https://monkeep.netlify.app/

## Tech Stack

**FRONTEND:**

- React
- React Router V6
- Context API
- Reducer
- spectre component Library
- useReducer and useContext
- Localstorage
- React-router-DOM
- Axios

**BACKEND:**

- Mockbee (Mock Backend)

## How to Start on local system

Clone the project

```js
git clone https://github.com/t007rushi/Monkeep.git
```

Go to the project directory

```js
cd monkeep
```

Install dependencies

```js
npm install
```

Start the server

```js
npm run start
```

## Functionalities

- CRUD operations on Note
- Add label, priorites, color to a Note
- Filtering and Sorting
- Filter by labels/tags
- Filter by priorities
- sort by time/date
- Frontend Authentication
- Sign In
- Sign Up
- Sign Out

## Demo
![recording](https://netlify-cocoon.netlify.app/.netlify/functions/fetch?code=307&path=eyJzaXRlX2lkIjoiZmM2NTEzNmEtOTAwZi00YmU4LWJiODAtNWQ2NzFlMWJmMjhmIiwiZGVwbG95X2lkIjoiNjI0ODBiNmRjNTkxNTMwMDBiMjJmZTY2IiwiaWQiOiI4MDU2YWZiZS05NmUxLTRkOWEtYWViYy04ZjlkMDE4NTA3MDgifQ==)

## Author

- [@t007rushi](https://github.com/t007rushi)

## Acknowledgements

- [neoG Camp](https://neog.camp/)
- [Tanay Pratap](https://twitter.com/tanaypratap)
- [Vikram Santhalia](https://twitter.com/VikramSanthalia)



## 🔗 Links

[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/rushikeshtarapure/)
[![twitter](https://img.shields.io/badge/twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/Neo_MonkStar)

0 comments on commit 4e392e5

Please sign in to comment.