A simple github alternative open source on github (ironic right ?), it aims is to be fully functionnal with some of the core features of github working.

See #84 for more info on the supported features.

Expect stuff to break.

• Next App Router
• drizzle local Postgres database
• Hosted to a custom VPS, see the CI/CD workflow for how it is all deployed
• tailwindCSS for the styling

• Node >= v18.x
• pnpm >= v8.x
• docker installed for local development
• A registered github app for authenticating users

1. First you have to clone the repository

   git clone https://github.com/Fredkiss3/gh-next.git

2. Start the docker compose instance to start the DB redis instance :

   docker-compose up -d --remove-orphans

3. Install the dependencies :

   pnpm install

4. Rename .env.example to .env.local And change the file to your needs,

5. And launch the project :

   pnpm run dev

   The app will show at http://localhost:3000.

6. Open the source code and start rocking ! 😎

A quick look at the top-level files and directories you will see in this project.

  .
  ├── src/
  │    ├── app
  │    ├── actions
  │    ├── components
  │    ├── models
  │    └── lib/
  │         ├── client
  │         ├── server
  │         └── shared
  ├── biome.json
  ├── pnpm-lock.yaml
  └── tsconfig.json

1. src/app/: this folder contains all the routes & pages of our app.

2. src/actions : this folder contains all the logic of our app.

3. src/components : this folder contains all the components of our app.

4. src/models : this folder contains all the DB models of our app.

5. src/lib/: this folder contains utils & helpers used throughout our app :

   1. client : this folder contains all the utilities that are client-only, usually used by client components. It contains mainly hooks

   2. server : this folder contains all the utilities that are server-only, for use within server components and server actions. It also contains the DB schemas inside db/schema

   3. shared : this folder contains all the utilities that are shared between the server & client, these can be used anywhere in the app.

6. biome.json: this file contains the configuration for biome to enable autoformatting.

7. pnpm-lock.yaml: this file contains the dependencies lock for the repo.

8. tsconfig.json: this file contains the configuration for typescript, that are used by the all the underlying packages