lore's Introduction

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).

lore's People

Contributors

Watchers

lore's Issues

NodeJS error during initial startup on Debian

Encountered following error message when first time running pnpm run dev after following the Debian 12 example install commands.

After this it starts successfully with pnpm run dev however. Saving here for now as a known issue / note.

╭─user@mx-t480s ~/dev/lore ‹main●›
╰─$ pnpm run dev

> [email protected] dev /home/user/dev/lore
> strapi develop

⠋ Building build context
⠙ Building build context[INFO] Including the following ENV variables as part of the JS bundle:
- ADMIN_PATH
- STRAPI_ADMIN_BACKEND_URL
- STRAPI_TELEMETRY_DISABLED
✔ Building build context (241ms)
✔ Creating admin (15490ms)
⠋ Loading Strapi
╭──────────────────────────────────────────────────────────────────────────────╮
│                                                                              │
│             A new version of Strapi is available 4.15.5 → 4.16.2             │
│   Check out the new releases at: https://github.com/strapi/strapi/releases   │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯

⠦ Loading Strapi[2023-12-25 19:37:37.315] warn: Users-permissions registration has defaulted to accepting the followingadditional user fields during registration: matrixId,paymentReference,avatar,memberships
✔ Loading Strapi (3929ms)
⠋ Generating typesnode:internal/assert:14
throw new ERR_INTERNAL_ASSERTION(message);
^

Error [ERR_INTERNAL_ASSERTION]: This is caused by either a bug in Node.js or incorrect usage of Node.js internals.
Please open an issue with this stack trace at https://github.com/nodejs/node/issues

documentation doesn't include all the fields on user

The roles and permissions plugin has a standard documentation that is referenced by the documentation plugin to generate the swagger docs. We should try to ensure that the fields on user that we have added ourselves are included in the documentation, such as matrixId

Recommend Projects

hacklabjkl / lore Goto Github PK