https://github.com/rafaelnogueiraxd/jarvas

This is the Jarvas API, a key component of the project. If you are not familiar with Jarvas, it is a chatbot application that simplifies a developer's life by assisting in program development, notifying the developer, and storing, processing, and explaining information based on user needs.
https://github.com/rafaelnogueiraxd/jarvas

api api-rest automation fastapi poetry poetry-python pyhon pytest python3 sqlite3

Last synced: 3 months ago
JSON representation

This is the Jarvas API, a key component of the project. If you are not familiar with Jarvas, it is a chatbot application that simplifies a developer's life by assisting in program development, notifying the developer, and storing, processing, and explaining information based on user needs.

• Host: GitHub
• URL: https://github.com/rafaelnogueiraxd/jarvas
• Owner: RafaelNogueiraXD
• Created: 2024-07-29T18:21:07.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-10-29T12:43:53.000Z (4 months ago)
• Last Synced: 2024-10-29T15:12:52.082Z (4 months ago)
• Topics: api, api-rest, automation, fastapi, poetry, poetry-python, pyhon, pytest, python3, sqlite3
• Language: Python
• Homepage:
• Size: 1.13 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Welcome to the Jarvas Project! 👋



This is the Jarvas API, a key component of the project. If you are not familiar with Jarvas, it is a chatbot application that simplifies a developer's life by assisting in program development, notifying the developer, and storing, processing, and explaining information based on user needs.







How to Use



This is a Python application that leverages various libraries, including FastAPI for route creation, Poetry for virtual environment management, and Pytest for application testing, among others.



Let’s begin by installing Poetry:


 ```

pip install poetry

 ```

Dowload the repository:


 ```

git clone https://github.com/RafaelNogueiraXD/jarvas.git

 ```

Start the virtual environment with:


 ```

poetry shell

 ```

Now, we can install the project dependencies:

 

 ```

poetry install

 ```


To verify that the application is working correctly, run:


 ```

task test

 ```

You should see something similar to:



To start the application, use:


 ```

task run

 ```



Next Steps:

Now that you have the API installed, you can use the Jarvas library to assist you in testing your applications!

Jarvas Library


This is a C4 model diagram to help you understand all the steps of the Jarvas Project: