To run the application on your local system do the following:

1. Clone the repository:

git clone https://github.com/Nneji123/WordsAI.git

2. Change the directory:

cd WordsAI

3. Install the requirements:

pip install -r requirements.txt

4. Run the application

uvicorn app:app --reload --port 8000

You should be able to view the application by going to http://127.0.0.1:8000/

You can also run the application in a docker container using docker compose(if you have it installed)

1. Clone the repository:

git clone https://github.com/Nneji123/WordsAI.git

2. Change the directory:

cd WordsAI

3. Run the docker compose command

docker compose up -d --build 

You should be able to view the application by going to http://localhost:8000/

Click the button below to start a new development environment:

To test the HTML Web app do the following:

1. Clone the repository:

git clone https://github.com/Nneji123/WordsAI.git

2. Change the working directory and install the requirements and pytest:

cd src && pip install -r requirements.txt && pip install pytest

3. Move to the tests folder and run the tests

cd .. && cd tests && pytest

To test the API functions do the following:

1. Clone the repository:

git clone https://github.com/Nneji123/WordsAI.git

2. Change the working directory and install the requirements and pytest:

cd api && pip install -r requirements.txt && pip install pytest

3. Move to the tests folder and run the tests

cd .. && cd tests && pytest

Assuming you have git and heroku cli installed just carry out the following steps:

1. Clone the repository:

git clone https://github.com/Nneji123/WordsAI.git

2. Change the directory:

cd WordsAI

3. Login to Heroku

heroku login
heroku container:login

4. Create your application

heroku create your-app-name

Replace your-app-name with the name of your choosing.

5. Build the image and push to Container Registry:

heroku container:push web

6. Then release the image to your app:

heroku container:release web

Click the button below to deploy the application.

1. Fork this repository

2. Login to AWS, create a new AWS EC2 instance and make sure to allow outside traffic as shown in the screenshots below:

3. When the instance has been launched, copy the Public IP address of your instance and paste it in the 'fastapi_setup' file of your cloned repository as shown below

4. Connect to your instance and clone your forked repository, an example in my case:

git clone https://github.com/Nneji123/WordsAI.git

5. cd into your repository which is probably named 'WordsAI'. You can do that by running:

cd WordsAI 

6. Then run the setup.sh file to get your application up and running:

chmod u+x aws.sh
./aws.sh

You can then view the application by going to your Public IP's location, an example in my case will be: http://3.95.202.74:80/docs

You can also watch this video for a more in depth explanation on how to deploy a FastAPI application on AWS EC2: