Skip to content

Commit

Permalink
readme changed
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandyrzph committed Aug 5, 2022
1 parent 2159791 commit b7e1c59
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 2 deletions.
44 changes: 43 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,44 @@
# React-Course-Project
React-Course-Project

### React-Course-Project

PixelPlace is a place for people where they can share their art and browse art wallpapers from other people. The application uses Firebase services such as Firebase Authentication, Firestore Database, Firebase Storage.
<br />

> ## Application structure
- ### Public Part (for unauthenticated users)
- Home Page
- Login Page
- Register Page
- ### Private Part (for authenticated users)
- Posts Page with feature to like others posts
- Post Details page where you can see more and also leave a comment
- Delete comment in Post Details page (for owners of comment)
- Create Post Page with image upload to Firebase
- Edit Post page (for owners of the post)
- Delete Post (for owners of the post)

> ## Technologies and libraries used
- #### ReactJS
- #### React-router-dom (v6)
- #### React-Icons
- #### React-Spinners
- #### React-Toastify
- #### React-Firebase-hooks (cloud firestore hooks)
- #### TailwindCSS for styling the UI
- #### Formik (building forms)
- #### Yup (used for form validation)
- #### Firebase
- #### Firebase Authentication
- #### Cloud Firestore (No-SQL db which saves data in documents and collections)
- #### Firebase Storage

> ## Guide to start the application
To start the application simply clone the repo or download it.

- ### In the project's folder open terminal and type `npm install` or `npm i`.
- ### After the dependencies are installed successfully to run the application go to the project's directory by typing `cd pixelplace` or if your already are in the directory just type `npm run start`
- ### Your application should be running on `http://localhost:3000`.
1 change: 0 additions & 1 deletion pixelplace/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
"react-spinners": "^0.13.3",
"react-toastify": "^9.0.7",
"uuid": "^8.3.2",
"vue": "^2.7.8",
"web-vitals": "^2.1.4",
"yup": "^0.32.11"
},
Expand Down

0 comments on commit b7e1c59

Please sign in to comment.