Skip to content

Commit 3e86fd1

Browse files
committed
update: readme and contribution guideline
1 parent 71773ec commit 3e86fd1

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ This section guides you through submitting an enhancement suggestion for CONTRIB
109109

110110
#### How Do I Submit a Good Enhancement Suggestion?
111111

112-
Enhancement suggestions are tracked as [GitHub issues]https://github.com/genie360s/Fulusi/issues/new/choose).
112+
Enhancement suggestions are tracked as [GitHub issues](https://github.com/genie360s/Fulusi/issues/new/choose).
113113

114114
- Use a **clear and descriptive title** for the issue to identify the suggestion.
115115
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,25 +76,31 @@ pip install -r requirements.txt
7676
flask --app flaskr init-db
7777
```
7878

79-
11. Run the Flask development server, with debug option and port option
79+
11. Create a ```.env``` file and copy contents from ```example.env``` file and edit with respect to your variables
80+
81+
```bash
82+
touch .env && cp example.env .env
83+
```
84+
85+
12. Run the Flask development server, with debug option and port option
8086

8187
```bash
8288
flask --app flaskr run --debug --port 8070
8389
```
8490

85-
12. Navigate to the "/api/" directory
91+
13. Navigate to the "/api/" directory
8692

8793
```bash
8894
cd api
8995
```
9096

91-
13. Run the API server
97+
14. Run the API server
9298

9399
``` bash
94100
python3 api.py
95101
```
96102

97-
14. Hooray 🚀 ! Now the Project is ready and running
103+
15. Hooray 🚀 ! Now the Project is ready and running
98104

99105
## How I contribute ?
100106

0 commit comments

Comments
 (0)