TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.
TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
# web app
cd app
npm install
cd client
npm install
cd ..
npm run dev
# flask service
# set up your python venv
virtualenv env-name
source ${wtv path to your env}/env-name/bin/activate
# install flask dep in venv
# make sure u are in ur venv and in flask-ner-service dir
pip install -r requirements.txt
# set up FLASK_APP environment variable
export FLASK_APP=ner.py
flask run
Service | PORT |
---|---|
reactJS | 3000 |
nodeJS | 5001 |
flask | 5000 |
- Software dependencies
- Latest releases
- API references
TODO: Describe and show how to build your code and run the tests.
TODO: Explain how other users and developers can contribute to make your code better.
If you want to learn more about creating good readme files then refer the following guidelines. You can also seek inspiration from the below readme files: