https://github.com/davealdon/catechismus
https://github.com/davealdon/catechismus
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/davealdon/catechismus
- Owner: DaveAldon
- Created: 2023-06-08T15:30:01.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-08T17:19:02.000Z (almost 3 years ago)
- Last Synced: 2025-03-26T06:06:35.577Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://catechismus.vercel.app/
- Size: 1.32 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Catechismus
## 🚀 Getting Started
You will need to have [Node.js](https://nodejs.org/en/) installed on your machine. After cloning the repo, follow these steps:
1. Install dependencies: `npm install`
2. Run in local dev mode with hot reload: `npm run dev`
3. Navigate to [localhost:3000](http://localhost:3000) or whatever port is specified in the console output
When you're ready to deploy, follow these steps:
1. Build for production - reveals any compile issues: `npm run build`
2. Run in production (no hot reload): `npm run start`
3. Navigate to [localhost:3000](http://localhost:3000) or whatever port is specified in the console output
## Running the Google Sheet transformers
1. You will need a Google Auth service account with access to the google sheet - [see tutorial](https://www.webdavsystem.com/server/gsuite/service-account/)
2. Use the info from this service account to fill out your `.env` file based on the `.env.example` file
3. Run the scripts via the test cases: `npm run test`
4. They should pull the data and create json files in the `public/` folder
## Structure
- `src/` - This is where the frontend source code lives
- `database/` - This is where any scripts are that pull data from google sheets
- `public/` - This is where static assets live, such as the transformed json data