https://github.com/ghall89/membership-tool

https://github.com/ghall89/membership-tool

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/ghall89/membership-tool
• Owner: ghall89
• License: mit
• Created: 2024-02-04T20:03:02.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-02-08T03:44:02.000Z (9 months ago)
• Last Synced: 2024-02-08T04:34:56.997Z (9 months ago)
• Language: Astro
• Size: 137 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# membership-tool

## About

A simple CRM tool for managing family/group memberships for a museum or similar organization.

This is simply a learning project for building a rich web application with a database back-end without using React, NextJS, or a similar framework. It's not intended for use in a production environment.

## Installation

### Prerequisites

#### Bun

A fast, lightweight JavaScript bundler, package manager, and alternative to Node which runs on JavaScriptCore.

You can install Bun via Homebrew with `brew add bun`, or via [their website](https://bun.sh)

#### PostgreSQL

An open source relational database solution ideal for web apps.

The easiest way to get a PostgreSQL database up and running locally on a Mac is with [this app](https://postgresapp.com). You can also download it [here](https://www.postgresql.org/download/).

You can also choose to host your database online.

### Installation

1. After cloning the repo, add a file called `.env` in the project root, and add `POSTGRES_URL="postgresql://your.postgres.url"`, with the URL to your database instead of the placeholder, to the file.

2. From the root of this project, run the command `bun install` in your terminal to install the project dependencies.

3. Start up your database if you're running it locally, and run the command `bun run migrate` in your terminal. If you'd like to use sample data as well, you can also run `bun run seed` to add randomized fake data to your db.

4. Run the command `bun run dev` and navigate to `localhost:4321` in your browser of choice.