Get LaunchBase

Quick Start Guide

Welcome to the Quick Start Guide! This guide will walk you through the steps to get started with our Django boilerplate and run the development server. By following these instructions, you'll be able to clone the repository, set up a virtual environment, install the required dependencies, perform database migrations, create a superuser account, and start the development server.


Step 1: Clone the Repository

Once your purchase is completed you will receive a github invite to the launchbase private repo, you must clone the repository to your local machine. Open your terminal and run the following command:

git clone https://github.com/nealmick/launch

Step 2: Set Up a Virtual Environment

Next, navigate to the project directory and create a virtual environment. This will isolate the project's dependencies from your system-wide Python installation. Run the following command:

python3 -m venv env
source env/bin/activate

Step 4: Install Dependencies

With the virtual environment activated, you can now install the project dependencies. The required packages are listed in the requirements.txt file. Run the following command to install them:

pip3 install -r requirements.txt

Step 5: Perform Database Migrations

Before running the development server, you need to apply the database migrations. This ensures that your database schema is up to date with the latest changes in your Django models. Run the following command:

python3 manage.py migrate

Step 6: Create a Superuser Account

To access the Django admin interface and manage your application, you need to create a superuser account. Run the following command

python3 manage.py createsuperuser

Step 7: Start the Development Server

Now that you have completed all the setup steps, you can start the development server. Run the following command:

python3 manage.py runserver

Django will start the development server, and you should see output similar to the following:

Watching for file changes with StatReloader
Performing system checks...

System check identified no issues (0 silenced).
June 01, 2023 - 15:30:00
Django version 3.2.4, using settings 'myproject.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.

Open your web browser and visit http://localhost:8000/ to see your Django application up and running!

Conclusion

Congratulations! You have successfully cloned the repository, set up a virtual environment, installed the required dependencies, performed database migrations, created a superuser account, and started the development server.