Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modernize codebase #224

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
/node_modules
/.pnp
.pnp.js
package-lock.json

# testing
/coverage
Expand Down
26 changes: 19 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,36 @@
# TartanHacks Registration Site

This is the frontend website for the TartanHacks Registration System.

## Backend Configuration

1. [Deploy the backend](https://github.com/ScottyLabs/tartanhacks-backend/blob/master/README.md).

2. In `next.config.js`, set the links to the `local`, `development`, `staging`, and `production` backends.


## Getting Started
1. Install the dependencies with
```
npm install
```

2. Then, run the development server:
Install the dependencies and run the server via [Bun](https://bun.sh):

```
npm run dev
bun install
bun run build
bun start
```

After running these commands, you will see the changes on [http://localhost:3000](http://localhost:3000/)

## Contributing

Claim an [issue](https://github.com/ScottyLabs/tartanhacks-registration/issues) by assigning it to yourself. Then, create a branch for the issue you're working on. Follow the `<feature>` naming convention for your branch.

e.g. `Add-Prettier-Support`

## Merging your PR

After you finish working on your feature, create a new [PR](https://github.com/ScottyLabs/tartanhacks-registration/pulls) and request someone to review it.


The website can then be accessed at [http://localhost:3000](http://localhost:3000)

## Styling
Expand Down
Binary file added bun.lockb
Binary file not shown.
Loading
Loading