Grit One Quickstart¶

This document will get you up and running with Grit One.

Prerequisites¶

Before running the application, make sure to install the necessary dependencies. Follow these steps:

Open a terminal or command prompt. Clone the project from Github:
```
git clone https://github.com/gritholdings/grit-one-sdk-python
```
Assuming that you have a supported version of Python installed, you can first set up your environment with:
```
python3.13 -m venv env
source env/bin/activate
```
Note: If command not found: python3.13, use brew install python@3.13
Install the backend dependencies using pip:
```
pip install -r requirements.txt
```
This command will install all the Python packages listed in the requirements.txt file.
Perform necessary installation. This is to install Tailwind CSS.
```
chmod +x ./scripts/install.sh
./scripts/install.sh
```

For local development, add this in BASE_DIR/credentials.json:

{
    "SECRET_KEY": "xxxx",
    "DATABASE_PASSWORD": ""
}

Go to aws.amazon.com -> RDS -> DB Instances -> database instance. Copy this endpoint. Update 'HOST' in DATABASES in settings.py to use this value.
```
DATABASES = {
    'default': {
    ...
    'HOST': 'database-1-instance-1.xxxx.us-east-1.rds.amazonaws.com'
    }
}
```
Edit security group for the RDS.
- In aws.amazon.com, RDS, click on database-1-instance-1 -> connectivity & security -> EC2 Security Group - inbound -> Edit inbound rules.
- Remove the default rule, then add Type: PostgreSQL, Source: Anywhere-IPv4, then save rules.
- Note that this is for development only. Change this setting in production.
In aws.amazon.com, go to S3, then create (if it doesn't exist yet) a bucket for your chatbot vectorstores (assets).
```
@dataclass
class CustomConfig(Config):
   aws_s3_bucket_name: str = "yourdomain.example.com-assets"
```

In IAM, create a new user (if it doesn't exist yet) to access the S3 bucket. Then, add in credentials.json:

{
    ...
    "AWS_ACCESS_KEY_ID": "YOUR_AWS_ACCESS_KEY_ID",
    "AWS_SECRET_ACCESS_KEY": "YOUR_AWS_SECRET_ACCESS_KEY"
}

Run python manage.py migrate to apply database migrations for the first time.
Create a new super admin. Run python manage.py createsuperuser, input email and password.

To test authentication run the following:

curl -X POST -d "username=your_username&password=your_password" http://localhost:8000/auth/login/ -c cookies.txt