Quick Start¶

Welcome to the Quick Start guide! Follow these steps to get your application up and running:

Running with Docker¶

To quickly launch the application using Docker, execute the following command:

docker run --name nxtbn_backend -p 8000:8000 -v static_data:/backend/staticfiles -v $(pwd)/dist/media:/backend/media nxtbn/nxtbn:latest

To access the application, navigate to: http://127.0.0.1:8000

To create a superuser, first log in to the Docker container interactively:

docker exec -it nxtbn_backend bash

Then, run the following command:

python manage.py createsuperuser

You are now ready to interact with nxtbn

Without Docker¶

  1. Clone the Repository: Retrieve the code from our GitHub repository.

  2. Install Dependencies: Follow the installation guide to set up the required dependencies.

  3. Run the Application: Use our step-by-step instructions to start the nxtbn application in your local environment.

  4. Explore Documentation: Discover the various features and customization options available.

Setting Up Backend for Development¶

Follow these steps to configure the backend for development:

  1. Clone the Repository:

    If you have configured an SSH key:

    git clone [email protected]:nxtbn-com/nxtbn.git

    If you have not configured an SSH key:

    git clone https://github.com/nxtbn-com/nxtbn.git

  2. Navigate to the Project Directory:

    cd nxtbn

  3. Copy the Environment Variables File:

    cp env.example .env

  4. Activate the Virtual Environment:

    pipenv shell

  5. Install Dependencies:

    pipenv install

  6. Apply Database Migrations:

    python manage.py migrate

  7. Initialize Necessary Data:

    python manage.py nxtbn_init

  8. Run the Development Server:

    python manage.py runserver

API Documentation¶

Access the application at: http://127.0.0.1:8000