Skip to content

This is a hackathon board frontend which connects to urban-spoon(the backend)

License

Notifications You must be signed in to change notification settings

JS-Hub-ZW/hackathon-board

Repository files navigation

Hackathon Board 👨‍💻

A site where people can post hackathons and register hackathons

Stack

  • NextJS
  • Chakra UI
  • Octocat
  • Cypress

Design

You can check the design from DESIGN.md

Installation

To install follow these instuctions

Clone the project: git clone https://github.com/JS-Hub-ZW/hackathon-board

Navigate to folder:

cd hackathon-board 

Install dependencies:

pnpm install 

Add configuration:

Check .env.example to see the kind of configuration that we need. Then create an .env.local file with your configuration

Run it up:

pnpm dev

Testing

Cypress

We use cypres for E2E tests and for Components tests.

To run it type the following:

pnpm cy:open

Contribution

If you find bugs or if you have new features please create an Issue. You can also check the Issue section and ask to be assigned. We respond within a day.

Containerization

You should be able to run hackathon board in a Docker container

Build the image:

sudo sh build.sh

Run the image:

Modify run.sh and run it:

sudo sh run.sh