Astro Pizza Cat

📖 Overview

The project is developed by software engineering students as their P2 project. The project tries to eliminate all "metawork" in the startup phase. Metawork is something like setting up github repository, discord server, overleaf documents and more.

👌 Requirements

NodeJS (Installation Linux )
MongoDB server ( Installation Linux )

⚡ Quick start

Clone the git down to your desired folder.

git clone https://github.com/KB885/Astro.git

cd into the folder and install the needed libs needed. Eg. Tailwindcss, Express

npm install

cd into the src folder and rename the configuration file to .env

cp .env.example .env

Compile the needed frontend

npm run build:css

A secret key has to be generated. This key needs to be copied into the .env file under SECRET_KEY

npm run generate:key

Before the database works, some settings have to be set, e.g. whether it should run on cloud or local. This means you need to have a mongodb server running locally or on the cloud. For the installation of this referr to the documentation here (Linux)

🛠️ Configuration

⚠️ License