Startup Directory

A startup directory built by Founders at the University of Illinois at Urbana-Champaign. Built with Next.js and MongoDB.

Getting Started

Make sure you have Docker Desktop installed on your computer and proceed through the following steps:

1. Clone The Repository

git clone https://github.com/founders/startup-directory.git

2. Startup The Development Environment

docker-compose up

3. Create A New Branch

When building out a new feature or fixing an existing issue make sure to check into a new branch. Name your branch after a concise description of the ticket you are working on (e.g. add responsive card, add /users endpoint, etc)

git checkout -b <branch-name>

4. Commit Your Changes

git commit -m 'A Descriptive Message'

5. Push A Remote Branch

git push --set-upstream origin <branch-name>
# or simply
git push

6. Open a Pull Request

Open a Pull Request on Github, assign yourself to it and tag @SirajChokshi for a review.

Testing Changes

To test changes made to the Startup Directory, we'll use our local testing environment. The Startup Directory is deployed live through a hosting service called "Vercel". When we push changes to our master git branch, it triggers a new deploy that causes those changes to propogate to production.

If we want to test changes before putting up a pull request, we can access the development server by running:

$ docker-compose up

Alternatively, if you don't want to use docker, we can just run this using next directly:

$ yarn && yarn dev

These will both run test instances on port 3000. Navigate to localhost:3000 to test changes.