Skip to content

Commit 9d885ca

Browse files
committed
Final Commit with Readme
1 parent fc3cca4 commit 9d885ca

14 files changed

+49
-69
lines changed

README.md

Lines changed: 26 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,34 @@
1-
# Getting Started with Create React App
1+
# **📑Notes App with React and Appwrite**
2+
![React Logo](./file.svg)
23

3-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
4+
# 🔷About the app:
5+
#### Its a notes app in which user can signin (Powered by appwrite's authentication) or signup and create notes with different categories.
6+
![Login Page](./ReadmeResources/loginscreenshot.jpg)
7+
![Inside the app](./ReadmeResources/inside.jpg)
48

5-
## Available Scripts
9+
## ♦ Features
10+
1. User Authentication (Sign In and Sign Up)
11+
1. Create and delete notes.
12+
1. Add different categories.
13+
1. Manage your notes throughout different categories.
14+
15+
## Features Demo :
16+
1. User Authentication :
17+
![Inside the app](./ReadmeResources/login2.gif)
618

7-
In the project directory, you can run:
19+
2. Create, Edit and Delete Notes :
820

9-
### `yarn start`
21+
![Inside the app](./ReadmeResources/createnote.gif)
1022

11-
Runs the app in the development mode.\
12-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
23+
3. Create Category and manage notes according to categories.
24+
25+
User can create different notes with different categories but new users get a default category called RECENTS which contains all the notes
26+
27+
![Inside the app](./ReadmeResources/createcategory.gif)
1328

14-
The page will reload if you make edits.\
15-
You will also see any lint errors in the console.
29+
### How to run?
30+
yarn start
31+
or
1632

17-
### `yarn test`
33+
npm start
1834

19-
Launches the test runner in the interactive watch mode.\
20-
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
21-
22-
### `yarn build`
23-
24-
Builds the app for production to the `build` folder.\
25-
It correctly bundles React in production mode and optimizes the build for the best performance.
26-
27-
The build is minified and the filenames include the hashes.\
28-
Your app is ready to be deployed!
29-
30-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
31-
32-
### `yarn eject`
33-
34-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
35-
36-
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
37-
38-
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
39-
40-
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
41-
42-
## Learn More
43-
44-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
45-
46-
To learn React, check out the [React documentation](https://reactjs.org/).
47-
48-
### Code Splitting
49-
50-
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
51-
52-
### Analyzing the Bundle Size
53-
54-
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
55-
56-
### Making a Progressive Web App
57-
58-
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
59-
60-
### Advanced Configuration
61-
62-
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
63-
64-
### Deployment
65-
66-
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
67-
68-
### `yarn build` fails to minify
69-
70-
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)

ReadmeResources/appwrite.svg

Lines changed: 4 additions & 0 deletions
Loading

ReadmeResources/createcategory.gif

2.5 MB
Loading

ReadmeResources/createnote.gif

1.56 MB
Loading

0 commit comments

Comments
 (0)