# Installation

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

# Built With

Rapua is built with the GOTH stack: Go, (SQLite), HTMX, and TailwindCSS.

# Prerequisites

Ensure you have Go installed on your machine. If not, you can download it from the official website here. Make sure the version is at least what is shown in the badge above. You can check the version by running the following command in your terminal:

go version

You will also need to have SQLite installed on your machine. If you don’t have it installed, you can download it from the official website here.

# Installing

1. Clone the repo

   git clone https://github.com/nathanhollows/Rapua.git
   

2. Change into the project directory

    cd Rapua
   

3. Set the .env file

   cp .env.template .env
   

   Update the .env file with your database details

   vi .env
   

4. Build the project

   make build
   

   Other build options are available including make dev, make tailwind-build, make tailwind-watch, make templ-watch, make templ-generate, and make test.
5. Run database migrations

   ./rapua db migrate
   

6. Set folder permissions (Unix only)

   mkdir -p ./static/uploads
   chown -R $(whoami) ./static/uploads
   

   This is required for the application to be able to write files to the uploads directory. You can change this to a more secure setting later.
7. Run the project

   ./rapua
   

8. Open your browser and navigate to http://localhost:8090

(back to top)