Open source project matching platform

Hack Days is a platform for finding/matching open-source projects, that helps connect good projects with good people. Currently in development.

[ English | 日本語 ]

Website

Still in development. Coming soon!

Requirements

• Git
• Docker (make sure the daemon is up and running)
• Supabase CLI (instructions here)

Getting Started

Setup the repository

git clone https://github.com/codeforjapan/hackdays.git

Launch Supabase local instance

supabase start

You will see the output like the following. Copy anon key.

         API URL: http://localhost:54321
          DB URL: postgresql://postgres:postgres@localhost:54322/postgres
      Studio URL: http://localhost:54323
        anon key: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoiYW5vbiJ9.ZopqoUt20nEV9cklpv9e3yw3PVyZLmKs5qLD6nGL1SI
service_role key: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoic2VydmljZV9yb2xlIn0.M2d2z4SFn5C7HlJlaSLfrzuYim9nbY_XI40uWFN3hEE

Create .env.development.local

Copy sample .env file

cp .env.development.local.sample .env.development.local
vi .env.development.local

Replace the YOUR_ANON_KEY_HERE with the anon key copied at the previous step.

NEXT_PUBLIC_SUPABASE_URL=http://localhost:54321
NEXT_PUBLIC_SUPABASE_ANON_KEY=YOUR_ANON_KEY_HERE <- replace this
NEXT_PUBLIC_SUPABASE_SERVICE_ROLE_KEY=YOUR_SERVICE_ROLE_KEY_HERE <- replace this

Note: if you want to connect the app to the hosted instance e.g. app.supabase.io, please retrieve API URL and anon key from the dashboard. (see docs/DEPLOYMENT.md for details)

Create a new environment file for the test purpose

cp .env.development.local .env.test.local

Start development server

# install dependencies
yarn install
# launch website
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can access Supabase Studio via http://localhost:54323/, that provides the dashboard where you can check various type of information such as database and Supabase Auth.

Also, you can access email logs (inbucket) via http://localhost:54324/.

CAUTION

Currently, Supabase Storage is not supported in the local supabase environment. You have to use a hosted instance for checking the features that use Storage, e.g. profile photos.

Deployment

See docs/DEPLOYMENT.md

Run tests

Cypress

Cypress is used for End-to-End (E2E) and Integration Testing.

Before you run a test, you have to create .env.production.local and copy the contents of .env.development.local to it.

Note: this is because the environmental variables related to Supabase must be defined to build the entire app. We're making the app able to be built without Supabase connected, to run the tests in CI where Supabase may not be configured.

To run Cypress tests, first run yarn build && yarn start, and then, in another terminal:

yarn cypress

# Or, if you want to run in headless mode that is suitable to Docker
# yarn cypress:headless

If you want to start the Next.js server and Cypress at the same time, the start-server-and-test package will help you. (Details)

Unit tests (Jest + React Testing Library)

The unit tests are built with Jest and React Testing Library, generally located at src/__tests__/ directory.

yarn test will run the tests in watch mode, where they will be re-run when a file is changed, while yarn test:ci will run them only once, which will be best for CI.

Also, yarn test:coverage will check the test coverage.

License

MIT License

Learn More

To learn more about this project, please visit our document pages