Skip to content

Commit

Permalink
merging from dev branch version 0.1.1
Browse files Browse the repository at this point in the history
aftenotes is in 0.1.1 but it's still in beta
  • Loading branch information
tuuhin authored Apr 7, 2022
2 parents 304b978 + f814019 commit 2bfe091
Show file tree
Hide file tree
Showing 37 changed files with 1,475 additions and 1,353 deletions.
64 changes: 47 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,58 @@
# REACT NOTE APP

A note app made with react with a custom rich text editor made from scratch using slate js ,as slate js is in beta but its development is still going on,hopefully with the inclusion of new feature this app will also get more interactive but for now lets wrap up the things. again development in this app will start in between feburary march .Hope slate js will be much stable that time
A note app made with `react` with a custom rich text editor made with `slate js` and `firebase`.

### Backend
## Firebase🔥

Firebase is notonly used as a backend server but too for hosting ,authenticating the users and as a storage bucket.
Google Firebase is a Google-backed application development software that enables developers to develop iOS, Android and Web apps.Here our app **afternotes** which is a web app, depends on firebase for the following features.

- **Firebase Auth**
User authentication via email and password provider and google sign in provider .
- **Cloud firestore**
The database used for storing the notes and the user related information
- **Storage**
Firebase Storage is used for storing the userprofile images
- **Hosting**
for hosting the site.
- **Firebase Auth 🦸**
Every app requires an authentication system,firebase provides us with basic `email and password` signin and along with all the major OAuth providers like `facebook`,`google` and many others .
For this project we are mainly using above cited providers only.

> Url for the webApp : [note-app](https://notify-b3141.web.app/)
- **Cloud firestore 🧮**
Cloud firestore is the database of our project .The cloud firestore is a `NoSql` database similar to `monogdb`.The data is being stored in the cloud firestore appoximately like the `graph `shown below.

for the mean time removed hosting.
```mermaid
stateDiagram
Users --> User1
Users --> User2
User1 --> Credentials1
User1 --> Notes
Notes --> Note1
Note1 --> Heading
Note1 --> Tags
Note1 --> ActualNote
User2 --> Credentials2
Credentials2 --> photoURL
Credentials2 --> createdAt
Credentials2 --> updatedAt
```

### Front End
- **Cloud Storage🏪**
As we have authenticated the user ,we needmake a profile page which ➡️ leads to the use cloud storage.`cloud storage` is simply a storage bucket to store the files.
```mermaid
stateDiagram
user --> picture1
user --> picture2
credentails --> picture2
```
The last saved or added image is used as the user image
- **Hosting🌏**
Being a web project, thus taking advantage of firebase hosting and following the [instruction](https://firebase.google.com/docs/hosting/quickstart).The project can be easity hosted.[URL](https://notify-b3141.web.app/)

For the frontend as the name suggest we are using react.
## Slate js 🖋️

### Conclusion
[Slate](https://docs.slatejs.org/v/v0.47/) is a completely customizable framework for building rich text editors.

The app is not yet build completely but it would be soon be completed .
> 🤖 Slate is currently in beta. Its core API is usable now, Some of its APIs are not "finalized" and will (breaking) change over time as we find better solutions.
## Problems 💢

This version 0.1.1 seems better than the previous one but still it's isn't complete . the notes can't be updated yet due to some problem with slate js. Thus there is no reason for update notes ,yet delete can be perferformed.

> 👽 Project is not finised
## Conslusion ✋

The project is done properly ,but not good for usage , thus it can be said it's a hobby project, I am ending this project here ,feel free to contibute and let's make afternotes a proper notes app which it's supposed to be .
Loading

0 comments on commit 2bfe091

Please sign in to comment.