readme (#20)

* readme

* codeblock

* Update README.md

image

Author: Eric S

README.md

@@ -1,59 +1,72 @@
-# Flask + Descope Authentication (and a little bit of React) 
+![react-flask](https://github.com/descope-sample-apps/flask-react-sample-app/assets/59460685/d38a6e4c-56ff-49f5-a0f1-fdf86bd4109d)
 
-Using the Python framework Flask + React.js + Descope Python SDK to add and manage basic authentication and roles. The project will feature multiple pages, protected routes, and logout functionality. 
+# Flask-React Sample app with Descope Auth
 
-<br>
+Add Descope's Python SDK to add authentication to a Flask + React.js app. The project will feature multiple pages, protected routes, and logout functionality. 
 
-## Installing Dependencies 🛠️
+## ⚙️ Setup
 
-In the root directory of the project, run the following to install all dependencies: ```npm run setup```
+1. Clone the repository:
 
-### Client Setup
+```
+git clone https://github.com/descope-sample-apps/flask-react-sample-app.git
+```
 
-1. Create a ```.env``` file in the root directory of the `client` folder and add your Descope [Project ID](https://app.descope.com/settings/project) in the file: ```REACT_APP_PROJECT_ID=YOUR_DESCOPE_PROJECT_ID```
+2. Install dependencies:
 
-> **NOTE**: If you're running your flask server on a different port than 5000, change the ```"proxy":"http://127.0.0.1:5000/"``` value to wherever your server is hosted. You can edit the proxy value in your client package.json file. 
+```
+npm run setup
+```
 
-<br> 
+3.  Client Setup
 
-### Server Setup
+Create a ```.env``` file in the root directory of the `client` folder and add your Descope [Project ID](https://app.descope.com/settings/project) in the file: 
+
+```
+REACT_APP_PROJECT_ID="YOUR_DESCOPE_PROJECT_ID"
+```
+
+> **NOTE**: If you're running your flask server on a different port than 5000, change the ```"proxy":"http://127.0.0.1:5000/"``` value to wherever your server is hosted. You can edit the proxy value in your client package.json file.  
+
+4. Server Setup
 
 Since this app also showcases roles, it will require you to set them up in the Descope Console.
 
-1. Create two different [roles]((https://app.descope.com/authorization)) called "teacher" and "student" <br>
-2. Create a ```.env``` file in the server folder and add your project id in the file:  
-    ```
-    PROJECT_ID="YOUR_DESCOPE_PROJECT_ID"
-    ```
+- Create two different [roles]((https://app.descope.com/authorization)) called "teacher" and "student" <br>
+- Create a ```.env``` file in the server folder and add your project id in the file:  
+```
+PROJECT_ID="YOUR_DESCOPE_PROJECT_ID"
+```
 
-<br>
+## 🔮 Running the Application 
 
-## Running the Application 💡
+To run the server: 
 
-Have at least 2 different terminals open, one command for each terminal. Run the following commands in the project root directory.
-- To run the server: ```npm run server```
-- To run the client: ```npm run client``` 
+```
+npm run server
+```
 
-<br>
+To run the client: 
 
-## Folder Structure 📁
+```
+npm run client
+``` 
+
+## 📁 Folder Structure 
 
 - Server: the server folder contains the flask app and server that will handle session validation 
     - `app.py`: our main flask app 
     - `requirements.txt`: a txt file with a list of our dependencies
 - Client: our react app 
 
-<br>
+## ⚠️ Issue Reporting
+
+For any issues or suggestions, feel free to open an issue in the GitHub repository.
 
-## What is going on? 🤔
+## 📜 License
 
-### How do I get started with Descope?
-If you don't have a Descope project or unsure what a project ID is, check out the [docs](https://docs.descope.com/build/guides/gettingstarted/)
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
-### What is Flask?
-Flask is a light-weight framework written in Python. It's super simple to get your web app started and running using Flask with just a couple of lines. To learn the basics of Flask, check out the official [documentation](https://flask.palletsprojects.com/en/2.3.x/quickstart/)<br>
 
-### What is React? 
-React is a JavaScript web framework used to create beautiful user interfaces. To learn the basics of React check out the official [documentation](https://react.dev/learn)