https://github.com/anidion/databook
Library Management System for a CPSC 471 Project at the University of Calgary
https://github.com/anidion/databook
drizzle-kit drizzle-orm expressjs mysql2 nextjs nextui
Last synced: about 1 month ago
JSON representation
Library Management System for a CPSC 471 Project at the University of Calgary
- Host: GitHub
- URL: https://github.com/anidion/databook
- Owner: Anidion
- Created: 2024-03-13T23:08:06.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-14T00:21:53.000Z (over 1 year ago)
- Last Synced: 2024-04-14T01:06:26.863Z (over 1 year ago)
- Topics: drizzle-kit, drizzle-orm, expressjs, mysql2, nextjs, nextui
- Language: TypeScript
- Homepage:
- Size: 4.63 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DataBook
## A CPSC 471 Project
### Authors
- Ben Schmidt
- Ohiomah Imohi
- Haris Ahmad
# Development Guide
## Basic Set Up
Install [nvm](https://github.com/nvm-sh/nvm), then run `nvm install 20.11.1` to install Node v20.11.1.
Run `corepack enable` to enable `yarn` in your shell. [More information on corepack](https://yarnpkg.com/corepack)
Now you can use `yarn` in the next steps.
## Database Set Up
Download [MySQL Community Server](https://dev.mysql.com/downloads/mysql/). Install it with the standard options.
```bash
mysql_secure_installation
```
Choose at most `LOW` for password validation
Set any password for `root`
Everything else can be answered `Y`
Now the default security setup is done
Next we need to create the user for the db
```bash
sudo mysql -u root -p
```
```sql
CREATE USER 'databook'@'localhost' IDENTIFIED BY 'cpsc4711';
GRANT CREATE, ALTER, DROP, INSERT, UPDATE, INDEX, DELETE, SELECT, REFERENCES, RELOAD on *.* TO 'databook'@'localhost' WITH GRANT OPTION;
FLUSH PRIVILEGES;
```
Now we create the database
```sql
CREATE DATABASE db;
```
Next up we can import an existing copy of the database. This command will import the dump we created of our DB into the local DB you just created.
```bash
cd Databook/
mysql -u root -p db < databook.sql
```
[Source](https://www.digitalocean.com/community/tutorials/how-to-import-and-export-databases-in-mysql-or-mariadb)
## First-time Set Up
Install packages
```bash
cd DataBook/
yarn
cd backend/
yarn
cd ../frontend
yarn
```
## Running Dev Environment
Running the backend will also run the migrations on the database you set up earlier
```bash
cd backend/
yarn dev
```
You can also use the VSCode Node.js debugger by hitting `F5` when `app.js` is focused.
```bash
cd frontend/
yarn dev
```
The frontend will be accessed on `localhost:3000`
The backend will be accessed on `localhost:3001` if needed
## Dev Instructions
## Editing the DB Schema
Don't edit the DB directly, we should use Drizzle-Kit Migrations.
Modify `backend/db/schema.js` to add/edit columns, using this to guide you: [Drizzle ORM - Schema Declaration](https://orm.drizzle.team/docs/sql-schema-declaration)
## Drizzle-Kit Studio
You can view the DB directly using Drizzle Studio, which also lets you test schemas with Drizzle syntax instead of just SQL like you would in DBeaver.
Start it by running
```bash
yarn drizzle-kit studio
```
## Querying the Database
Read the [Drizzle Docs](https://orm.drizzle.team/docs/select).
Note, we need to use `schema.table`
```javascript
const result = await db.select().from(schema.user);
```