Repository navigation
Installation Guide
This guide explains how to set up NexaWork on a local development environment.
Before installing NexaWork, make sure you have the requirements listed in System Requirements.
You will need:
- Python 3.11 or newer
- PostgreSQL
- Git
- A terminal
- A code editor such as VS Code
Clone the NexaWork repository:
git clone https://github.com/charlie-Tech-cmd/NexaWork.git
Move into the project directory:
cd NexaWork
Create a Python virtual environment:
python3 -m venv venv
Activate it on Linux or macOS:
source venv/bin/activate
On Windows:
venv\Scripts\activate
Install the project's Python dependencies:
pip install -r requirements.txt
Create your local environment configuration based on the project's environment configuration file.
Do not commit secrets, passwords, API keys, or other sensitive credentials to the repository.
Make sure PostgreSQL is running and configure the database connection using the project's environment settings.
Run the required database migrations before starting the application.
With the virtual environment activated, start the application using the project's configured development command.
Run the test suite with:
pytest
All tests should pass before submitting changes.
After starting NexaWork, verify that:
- The application starts without errors.
- The database connection is working.
- Database migrations have completed successfully.
- The API is accessible.
- The test suite passes.
Note: This guide will be updated as NexaWork's development environment and deployment process evolve.