jasalt / lore

Let's Organise the Registry Easily!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

lore

Let's Organise the Registry Easily!

Lore is a Strapi project used for keeping, maintaining and providing member data and other useful data for a hackerspace. Strapi comes with a full featured Command Line Interface (CLI) which lets you scaffold and manage your project in seconds.

Pre-requisities

Development packages

Following JavaScript development packages are required from OS package manager etc.

  • NodeJS runtime (version >=18.0.0 <=20.x.x)
  • pnpm NodeJS package manager

Debian 12 example:

sudo apt install nodejs npm
sudo npm install -g pnpm

Install Node Version Manager NVM with script or manually cloning repo as stated in official docs eg:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
nvm install 20.10.0
nvm use 20.10.0
pnpm install

This may have some room to improvement in how global pnpm NPM package is installed via APT NPM while NVM itself handles global packages separately for different NodeJS versions, but probably works okay for most parts to get started.

MacOS 14.1.2 example:

brew install node pnpm nvm
nvm install 20.10.0  # homebrew installs incompatible 21.x.x version by default
nvm use 20.10.0
pnpm install

Secrets and environment variables

In order to run the local development server, you need to set up some stuff in .env. Create a file in the root directory called .env, and copy the contents of .env.example into it.

cp .env.example .env

Commands

develop

Start your Strapi application with autoReload enabled. Learn more

pnpm run dev

start

Start your Strapi application with autoReload disabled. Learn more

pnpm run start

build

Build your admin panel. Learn more

pnpm run build

API

Strapi automatically generates a REST API based on the models.

To see the Swagger documentation for this API during local development, simply open http://localhost:1337/documentation/v1.0.0 (while the dev server is running).

About

Let's Organise the Registry Easily!

License:GNU General Public License v3.0


Languages

Language:JavaScript 83.1%Language:HTML 16.9%