> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.ruoomsoftware.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get started with Ruoom Core in a few simple steps

## Quickstart Guide for Ruoom Core

Welcome to Ruoom Core! Follow these steps to set up your development environment and start using Ruoom Core. For a visual walkthrough, check out our [instructional video](https://www.youtube.com/watch?v=BqPwiajnBf0).

### Setting Up Your Environment

1. **Clone the Repository**: Clone the Ruoom Core repository from GitHub to your local machine.

   ```bash theme={null}
   git clone https://github.com/your-username/ruoom-core.git
   cd ruoom-core
   ```

2. **Create PostgreSQL Database**: Create a PostgreSQL database called "Ruoom" owned by a user named "ruoom\_admin" with the password "password". You can do this manually using PGAdmin or using the following SQL commands:

   ```sql theme={null}
   CREATE DATABASE Ruoom;
   CREATE USER ruoom_admin WITH PASSWORD 'password';
   ALTER DATABASE Ruoom OWNER TO ruoom_admin;
   ```

3. **Install Requirements**: Install all necessary dependencies using the requirements file.

   ```bash theme={null}
   pip install -r requirements.txt
   ```

4. **Initialize the Database**: Set up PostgreSQL with a database called "Ruoom", a user called "ruoom\_admin", and password "password". Then, run the following command to apply migrations:

   ```bash theme={null}
   python manage.py migrate
   ```

5. **Run the Development Server**: Start the local development server to see Ruoom Core in action.

   ```bash theme={null}
   python manage.py runserver
   ```

   You can now access the application at `localhost:8000`. You should be met with the following page that allows you to create your admin credentials:

   <img src="https://mintcdn.com/ruoom/S58yk56t2CMCWBwZ/images/signup_page.png?fit=max&auto=format&n=S58yk56t2CMCWBwZ&q=85&s=77a0fe2a3bb1f28b3d3729c642c0212b" alt="Signup Page" width="728" height="657" data-path="images/signup_page.png" />

### Next Steps

* Explore the various plugins published by Ruoom to enhance the functionality of Ruoom Core.
* Contribute to the project by submitting issues or pull requests on GitHub.

For more detailed instructions, refer to the README file in the Ruoom Core repository.