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 https://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)
  │    │   └── (routes)
  │    └──lib/
  │        ├── db/schema
  │        └── hooks
  ├── .prettierrc
  ├── pnpm-lock.yaml
  └── tsconfig.json

1. src/app/: this folder contains the source code to our app :

   1. (actions) : this folder contains all the logic of our app.

   2. (components) : this folder contains all the components of our app.

   3. (models) : this folder contains all the DB models of our app.

   4. (routes) : this folder contains all the routes & pages of our app.

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

   1. db/schema : this folder contains all the drizzle sqlite schema for our DB.

   2. hooks : this folder contains all the react custom hooks used in the app.

3. .prettierrc: this file contains the configuration for prettier to enable autoformatting.

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

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