This repository was archived by the owner on Oct 30, 2022. It is now read-only.
File tree Expand file tree Collapse file tree 1 file changed +52
-0
lines changed
Expand file tree Collapse file tree 1 file changed +52
-0
lines changed Original file line number Diff line number Diff line change 1+ ### Setup the repository to your local environment.💌
2+ 1 . ` Fork ` the repository - Creates a replica of repository to your local environment.
3+ 2 . Clone the repository - Downloads all repo files to your machine, using
4+ ``` git
5+ git clone https://github.com/YOUR-USERNAME/code-sync
6+ ```
7+ 3 . Set working directory to the root directory of the project.
8+ ``` sh
9+ cd code-sync
10+ ```
11+ ## Frontend ⚛️
12+
13+ Following are the steps to run the frontend of the community-website on your local. All the frontend code will go in the ` client ` directory.
14+
15+ 1 . Navigate to ` client ` folder.
16+ ``` sh
17+ cd client
18+ ```
19+ 2 . Install all the required packages and dependencies.
20+ ``` node
21+ npm install
22+ ```
23+ 3 . Rename ``` .env.example ``` to ``` .env ``` & Fill data as described.
24+
25+
26+ ## Backend 💻
27+
28+ Following are the steps to run the backend of the community-website on your local. All the backend code will go in the ` @root ` folder.
29+
30+ 1 . Install all the required packages and dependencies on ``` @Root ``` folder under ``` code-sync ``` directory.
31+ ``` node
32+ npm install
33+ ```
34+ 2 . Rename ``` .env.example ``` to ``` .env ``` & Fill data as described.
35+
36+ ## Run/Compile ⏱️
37+ - If you wanna run frontend and backend at one time then you can run command
38+
39+ ``` node
40+ npm run dev
41+ ```
42+ - For Just Frontend/Client
43+
44+ ``` node
45+ npm run client
46+ ```
47+ - For Backend/Server
48+
49+ ``` node
50+ npm run server
51+ ```
52+ - Backend Run on port ``` localhost:ENV_PORT ``` & Frontend Run on ``` localhost:3000 ```
You can’t perform that action at this time.
0 commit comments