-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #112 from Folody-Team/phatdev12-patch-1
Update README.md
- Loading branch information
Showing
1 changed file
with
1 addition
and
127 deletions.
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,131 +1,5 @@ | ||
| <p align="center"><a href="#"><img src="https://cdn.folody.xyz/Group_6.svg" height="120"/></a></p> | ||
|
|
||
| <br/> | ||
| <h1 align="center">Shartube</h1> | ||
| <p align="center">Online sharing platform</p> | ||
|
|
||
| # What is Shartube | ||
|
|
||
| Shartue is a social networking platform that allows users to share stories and videos, and users can interact with each other by messaging and emotional interactions. | ||
|
|
||
| ## Environment Variables | ||
|
|
||
| To run this project, you will need to add the following environment variables to your .env file | ||
|
|
||
| `DB_HOST` | ||
| `DB_PORT` | ||
| `DB_USERNAME` | ||
| `DB_PASSWORD` | ||
| `DB_NAME` | ||
| `JWT_SECRET` | ||
|
|
||
|
|
||
| ## Run Locally | ||
|
|
||
| Clone the project | ||
|
|
||
| ### Frontend | ||
|
|
||
| If you want to run web application, please visit here. | ||
| ## **Web application** | ||
| ``` | ||
| cd web | ||
| ``` | ||
| > In this project we are using yarn. Before you do the next steps if you haven't downloaded yarn do the following. | ||
| <details close> | ||
|
|
||
| <summary>Install <b>yarn</b></summary> | ||
| <br/> | ||
|
|
||
| ``` | ||
| npm i -g yarn | ||
| ``` | ||
|
|
||
| </details> | ||
|
|
||
| Install all dependencies and run dev command. | ||
|
|
||
| <br/> | ||
|
|
||
| ``` | ||
| yarn dev | ||
| ``` | ||
|
|
||
| If you wanna build | ||
|
|
||
| ``` | ||
| yarn build | ||
| ``` | ||
|
|
||
| This is where you want to run your mobile app. | ||
|
|
||
| ## **Mobile app** | ||
|
|
||
| Firstly | ||
| ``` | ||
| cd app/mobile | ||
| ``` | ||
| Make sure you have downloaded all package dependencies | ||
|
|
||
| Check it out `package.json` | ||
|
|
||
| **Android** | ||
|
|
||
| ``` | ||
| yarn android | ||
| ``` | ||
|
|
||
| **IOS** | ||
|
|
||
| ``` | ||
| yarn ios | ||
| ``` | ||
|
|
||
| **Web** | ||
|
|
||
| ``` | ||
| yarn web | ||
| ``` | ||
|
|
||
| ### Backend | ||
|
|
||
| ```bash | ||
| git clone https://github.com/Folody-Team/Shartube/ | ||
| ``` | ||
|
|
||
| Go to the project directory | ||
|
|
||
| ```bash | ||
| cd Shartube | ||
| cd server | ||
| ``` | ||
|
|
||
| Start the server | ||
|
|
||
| ```bash | ||
| go run github.com/cosmtrek/air | ||
| ``` | ||
| Make sure you installed [**Golang**](https://go.dev/), [**NodeJs**](https://nodejs.org/). | ||
|
|
||
| ## Tech Stack | ||
|
|
||
| **Client:** Next.js, React, Redux, TailwindCSS,... | ||
|
|
||
| **Server:** Golang, Mux, Net/http,... | ||
|
|
||
| ## Support | ||
|
|
||
| For support, [join our Discord server](https://discord.gg/BbKvjwsYwM). | ||
|
|
||
| ## Contributing | ||
| Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. | ||
|
|
||
| Please make sure to update tests as appropriate. | ||
|
|
||
| ## Stargazers | ||
| [](https://github.com/Folody-Team/Shartube/stargazers) | ||
|
|
||
|
|
||
| <p align="center"><a href="#"><img src="http://randojs.com/images/backToTopButton.png" alt="Back to top" height="29"/></a></p> | ||
|
|
||
| The project has moved on https://github.com/sharproject/Shartube |