thullo

KO | EN

gitlite — search

#hacktoberfest #react #ai #llm #machine-learning #deep-learning #nodejs #windows #awesome #kubernetes #pytorch #security #ios #openai

(★ 14)

Thullo - Trello Clone

thullo Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Thullo : A Trello Clone

This project was made for a challenge Thullo by [devChallenges.io](https://devchallenges.io/challenges/wP0LbGgEeKhpFHUpPpDh).

# Requirements

- Node >= v16.6.2
- [docker](https://docs.docker.com/engine/install/)
- [docker-compose](https://docs.docker.com/compose/install/)  
- [PNPM](https://pnpm.io/installation) >= v6.22.2
- [MongoDB](https://docs.mongodb.com/manual/installation/) >= v5.0.4

## 🚀 How to work on the project ?

1. First you have to clone the repository
    
    ```bash
    git clone https://github.com/Fredkiss3/thullo.git
    ```

2. **Then, Install the dependencies :**

```bash
    pnpm install
    ```

3. **Launch the docker-compose server to start a mongodb server :**

```bash
    docker-compose up -d
    ```
4. Rename the `.env.example` located in `packages/express/src/config` to `.env.local` And change the file to your needs, 
   by default you have :

```dotenv
   # server
   PORT = 3031

# mongo database
   MONGO_URI='mongodb://root:password@localhost:27017/thullo?authSource=admin'
   ```

5. **And launch the project :**

```bash
    pnpm run dev --parallel
    ```

The express API will be available at [http://localhost:3031](http://localhost:3031) and the frontend client at [http://localhost:3000](http://localhost:3000).

6. **Open the source code and start rocking ! 😎**

## 🧐 Project structure

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

.
    ├── .github/
    │    └── workflows
    │        ├── domain.yml
    │        └── build-push-images.yml
    ├── packages/
    │   ├── domain
    │   ├── express
    │   ├── adapters
    │   └── front
    ├── .prettierrc
    ├── jest.config.json
    ├── pnpm-workspace.yaml
    ├── pnpm-lock.yaml
    └── tsconfig.json

1. **`.github/`**: this folder contains the GitHub Actions workflow configuration for Continuous Integration/Continuous Deployment.:
   
    1. **`build-push-images.yml`** : this workflow is used to build the images for the frontend & API.
    2. **`domain.yml`** : this workflow is used to test the domain.
   
   
2. **`packages/`**: this folder contains the monorepo packages, each package is a sub-folder :

1. **`domain`** : this package contains the domain logic used by the express App
   
    2. **`express`** : this package contains the express API.
   
    3. **`adapters`** : this package contains the implementations of all the interfaces in the domain that the express API will use.
   
    4. **`front`** : this package contains the frontend app written in React.
    
3. **`.prettierrc`**: this file contains the configuration for prettier to enable autoformatting.

4. **`jest.config.json`**: this file contains the configuration for Jest, that are used by the all the underlying packages

5. **`pnpm-workspace.yaml`**: this file contains the configuration for the monorepo.

6. **`pnpm-lock.yaml`**: this file contains the dependencies lock for the monorepo.

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

thullo

thullo Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

thullo

thullo Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README