Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ducomputingsociety authored Oct 23, 2024
1 parent a5e1b34 commit c4f5bc8
Showing 1 changed file with 9 additions and 43 deletions.
52 changes: 9 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,17 @@
# durhack-megateams
# durhack-guilds

[![Continuous Integration](https://github.com/ducompsoc/durhack-megateams/actions/workflows/ci.yml/badge.svg)](https://github.com/ducompsoc/durhack-megateams/actions/workflows/ci.yml)
[![Continuous Integration](https://github.com/ducompsoc/durhack-guilds/actions/workflows/ci.yml/badge.svg)](https://github.com/ducompsoc/durhack-guilds/actions/workflows/ci.yml)

Building the megateams project for DurHack 2023.
DurHack's 'Guilds' platform, built in-house by the DurHack team (2023-present).

## Stack
- Frontend framework: React.js
- CSS framework: Bootstrap (React-Bootstrap)
- Server Runtime: Node.js
- Package manager: NPM
- Database: MySQL
- `client` is a Next.js app using TypeScript and TailwindCSS, runs on Node.js
- `server` is an otterhttp (similar to Experss) app using TypeScript, runs on Node.js
- `server` requires access to a postgresql database for persistence/session management
- Nginx is used to direct incoming requests to the appropriate app


This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).

## Getting Started

First, run the development server:

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.

## Learn More

To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!

## Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
### Tooling
- We use `pnpm` for package management

## Nginx Configuration
```
Expand Down

0 comments on commit c4f5bc8

Please sign in to comment.