dzcode.io

The code for dzcode.io, a website for the Algerian open-source community.

Apps:

• ./web (dzcode.io or stage.dzcode.io)
• ./api (api.dzcode.io or api-stage.dzcode.io)

Packages:

• ./data
• ./packages/models
• ./packages/utils
• ./packages/tooling

Get Started

Prerequisites

Make sure you have:

• Git
• Node.js version 20 or higher (we recommend using volta over a plain install or nvm)
• Docker installed and running.

Run it locally

• Open a terminal and clone the repo:

git clone https://github.com/dzcode-io/dzcode.io.git

• Make sure you are in the project root:

cd dzcode.io

• Install dependencies:

npm install

• Run it locally:

npm run dev:all

• For the API server, go to http://localhost:7070
• For the web server, go to http://localhost:8080
• For the search server, go to http://localhost:7700

Please check the README.md files inside ./api and ./web for more info.

Contributing

To get started, see the contributing guidelines.

If you use VSCode, please make sure to have a .vscode/settings.json file with the content:

{
  "files.associations": {
    "*.css": "tailwindcss"
  },
  "prettier.configPath": "packages/tooling/.prettierrc",
  "prettier.prettierPath": "./node_modules/prettier/index.cjs",
  "eslint.options": { "overrideConfigFile": "packages/tooling/eslint.config.mjs" },
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": "always",
    "source.fixAll.ts": "always"
  }
}

Before You Create a Pull Request

• If you already forked the repository, please make sure your fork is up-to-date by following these simple steps.
• Please make sure your code follows the style guidelines defined in this repo. Simply run npm run lint:fix to ensure conformity. This process should happen automatically whenever you commit your changes, but you can always do it manually if your Pull Request checks are failing due to linting errors.

List Your Project

Follow these steps.

License

Licensed under the MIT license (Twitter: @dzcode_io).