-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
15d3667
commit 4dd56f2
Showing
1 changed file
with
95 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,95 @@ | ||
| # swirl | ||
| # Swirk | ||
| <a href="https://skillicons.dev"> | ||
| <img src="https://skillicons.dev/icons?i=mongodb,express,react,nodejs,sass,ts" /> | ||
| </a> | ||
|
|
||
| # Project Idea | ||
|
|
||
|
|
||
| The project idea was inspired by <a href="https://twitter.com">Twitter</a>. | ||
|
|
||
| # Table of Contents | ||
| - <a href="#about">About this Project</a> | ||
| - <a href="#how-to-run">How to run the app on your computer</a> | ||
| - <a href="#future-features">Future Features</a> | ||
| - <a href="#project-structure">Project Structure</a> | ||
| - <a href="#tools">Tools</a> | ||
| - <a href="#application-pictures">Application Pictures</a> | ||
|
|
||
|
|
||
| # <p id="about">About this project</p> | ||
|
|
||
| Swirk is a social meadia project and its similar to Twitter. It is a place where people can share their opinion on many different topics and ideas. They have full access to all of the resources on the server and can use many functionalities related to posting content online. | ||
|
|
||
| # <p id="how-to-run">How to run the app on your computer</p> | ||
|
|
||
| 1. You can download the project ZIP file or you can clone the repository directly. | ||
| 2. Open the project with IDE/Code Editor. | ||
| 3. Open terminal with `Ctrl + J`. | ||
| 4. Navigate to swirk folder with `cd swirk`. | ||
| 4. Then navigate to `client` folder with `cd client`. | ||
| 5. Type `npm i` to install all modules that are listed on `package.json` file and their dependencies. | ||
| 6. Type `npm start` to run the project in the browser. It will start on `http://localhost:3000`, but you can change it to another if necessary. Type `y` to do it. | ||
| 7. Do the steps 4, 5 and 6 with the server folder. | ||
| 7. Explore Swirk. | ||
| 8. Share your opinion and thoughts on Swirk. | ||
|
|
||
| # <p id="future-features">Future Features</p> | ||
|
|
||
| - <strong>Chat</strong> | ||
| - send message to user | ||
|
|
||
| - <strong>Discussions</strong> | ||
| - start discussion | ||
| - invite users to discussion | ||
|
|
||
| # <p id="project-structure">Project Structure</p> | ||
| - Client | ||
| - api - for all of the project api requests | ||
| - assets - for project assets | ||
| - components - all of the components used in multiple places | ||
| - constants - all of the project constant variables | ||
| - contexts - all of the project contexts | ||
| - features - all of the project features (authentication, posts, genres and profile) | ||
| - hooks - all of the custom hooks | ||
| - layouts - for every partial code used by many components | ||
| - lib - for 3rd party libraries and their configuration files | ||
| - pages - for all of the application pages that does not store complicated logic | ||
| - services - for each application service and its requests | ||
| - utils - that contains functions used in multiple files | ||
|
|
||
| - Server | ||
| - config - configuring the application | ||
| - constants - all of the project constant variables | ||
| - controllers - folder, where we can separate the route and the controller function | ||
| - models - stores database schemas | ||
| - routes - contains various application routes | ||
|
|
||
| # <p id="tools">Tools</p> | ||
|
|
||
| - <a href="https://reactjs.org/">React</a> | ||
| - <a href="https://www.typescriptlang.org/">TypeScript</a> | ||
| - <a href="https://reactrouter.com/">React Router</a> | ||
| - <a href="https://firebase.google.com/">Firebase</a> | ||
| - <a href="https://app.cyclic.sh/">Cyclic</a> | ||
| - <a href="https://nodejs.org/en/">Node</a> | ||
| - <a href="https://expressjs.com/">Express</a> | ||
| - <a href="https://www.npmjs.com/package/nodemon">nodemon</a> | ||
| - <a href="https://www.mongodb.com/">MongoDB</a> | ||
| - <a href="https://mongoosejs.com/">Mongoose</a> | ||
| - <a href="https://jwt.io/">jwt</a> | ||
| - <a href="https://www.npmjs.com/package/bcrypt">bcrypt</a> | ||
| - <a href="https://www.npmjs.com/package/dotenv">dotenv</a> | ||
|
|
||
| # <p id="application-pictures">Application Pictures</p> | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|