https://github.com/kennedybarreto/sticky-notes
Blocos de notas interativo estilo "Post-It"
https://github.com/kennedybarreto/sticky-notes
appwrite react
Last synced: about 2 months ago
JSON representation
Blocos de notas interativo estilo "Post-It"
- Host: GitHub
- URL: https://github.com/kennedybarreto/sticky-notes
- Owner: KennedyBarreto
- License: mit
- Created: 2024-08-12T19:18:55.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T15:31:18.000Z (over 1 year ago)
- Last Synced: 2024-10-25T21:08:56.796Z (over 1 year ago)
- Topics: appwrite, react
- Language: JavaScript
- Homepage: https://sticky-notes-psi-two.vercel.app
- Size: 159 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.en.md
- License: LICENSE.md
Awesome Lists containing this project
README
Sticky Notes - Note Block
About |
Features |
Technologies |
Prerequisites |
Getting Started |
License |
Author
## :dart: About
Interactive "Post-It" style note blocks. A Fullstack project built using React.js for the frontend and the [Appwrite](https://appwrite.io/) service for the backend. Based on a project by [freeCodeCamp.org](https://www.youtube.com/watch?v=yBThHM2pBbE)
## :sparkles: Features
:heavy_check_mark: Create notes and customize their colors;
:heavy_check_mark: Drag and drop notes anywhere on the screen;
:heavy_check_mark: Real-time storage and saving
## :rocket: Technologies
The following tools were used to build this project:
- [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML)
- [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS)
- [JS](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
- [ReactJS](https://react.dev/)
- [Appwrite](https://appwrite.io/)
## :white_check_mark: Prerequisites
1 - Make sure you have Node.js 20 or higher installed on your machine, along with a code editor to modify configuration files.
2 - The project uses the [Appwrite](https://appwrite.io/) service as the backend. To replicate it locally, create a project on the platform. For detailed instructions, read the [documentation](https://appwrite.io/docs).
3 - In the project folder, there is an example environment variables file (.env). Create or rename this file and replace it with your Appwrite project details. These variables will handle the connection between the service and the application.
## :checkered_flag: Getting Started
1 - Clone/Copy the repository to your machine
2 - Install dependencies
```bash
npm i
```
3 - Start the React project
```bash
npm run dev
```
## :construction: Next Steps
- [X] Add informative Toasts
- [x] Confirmation for important actions
- [ ] Encrypt notes in the database
- [ ] Design improvements
- [ ] Optimization enhancements
## :memo: License
This project is under the MIT license. See the [LICENSE](LICENSE.md) file for more details.
Made with :heart: by Kennedy Barreto
