Skip to content
This repository has been archived by the owner on Mar 2, 2024. It is now read-only.

Commit

Permalink
docs: Add some READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
bradenmacdonald committed Mar 20, 2023
1 parent 792f36b commit 8c95807
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Neolace is 100% written in TypeScript. Here's how the code is organized:
* __frontend__ - The Neolace frontend, a Next.js React application that implements our standard user interface. Plugins and theme settings can be used to customize the UI, or you can replace it entirely with a custom frontend.
* __neolace-admin__ - The Neolace Admin Tool, a command-line script that you can use for administrative purposes like importing or exporting data.
* __neolace-sdk__ - The Neolace Software Development Kit (SDK), which provides TypeScript interfaces for all of the Neolace entities. This code is shared by the frontend and the backend. It also contains an API client which makes it really easy to use the REST API.
* __sites__ - Example sites/content.

## Developer quickstart

Expand Down
6 changes: 6 additions & 0 deletions backend/neolace/lib/tests-default-data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,12 @@ export async function generateTestFixtures(): Promise<TestSetupData> {
realm:
* [**PlantDB**](http://plantdb.local.neolace.net:5555): A site showing an example of botany/biology content.
This site is intentionally kept very small and doesn't change often, because its content is used in many
of the backend's test cases, which expect a specific set of entries and relationships.
* [**BricksDB**](http://bricksdb.local.neolace.net:5555): A site that lets you browse the Rebrickable
dataset (LEGO bricks, sets, etc.). This site contains over 200,000 entries and is highly inter-connected.
- This site is not installed by default. To create it, open \`sites/bricksdb\` and run
\`./create-bricksdb.sh\` and \`./import-data.ts\`.
## Default user accounts
Expand Down
4 changes: 4 additions & 0 deletions sites/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Neolace Example Sites

This folder contains example sites that you can import into your Neolace
development environment and test or play with.
14 changes: 14 additions & 0 deletions sites/bricksdb/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# BricksDB Example Site

This is a Neolace site that lets you browse
[the Rebrickable dataset](https://rebrickable.com/downloads/)
(LEGO bricks, sets, etc.). The resulting Neolace Site contains over 200,000
entries and is highly inter-connected.

How to install:
1. Have Neolace running.
2. Open a terminal in this folder. (`sites/bricksdb`)
3. Run `./create-bricksdb.sh`
4. Run `./import-data.ts`

See the site at the local URL: http://bricksdb.local.neolace.net:5555

0 comments on commit 8c95807

Please sign in to comment.