yoganovvaindra / craft_backend

Backend Craft It App

A backend supporting an Android app for recognizing waste materials and converting them into handicrafts.

📖 Table of Contents

Table of Contents

1. ➤ About The Project
2. ➤ Technology
3. ➤ Folder Structure
4. ➤ Quick Start
5. ➤ Wiki
6. ➤ Contributors
7. ➤ Activities

📝 About The Project

This project is a backend for an Android application designed to recognize waste materials and transform them into handicrafts. The backend provides essential functionality to support the application, including data management, authentication, and communication with the Android client.

🍴 Technology

The following open source packages are used in this project:

• Express
• TypeScript
• Prisma
• Axios
• Docker

🌵 Folder Structure

code
.
│
├── .github
│   ├── raw_data
│   ├── raw_data
│   ├── raw_data
├── Key
├── Postman
│   ├── images
|   │   ├── 404.jpg
|   │   ├── aluminium.jpg
|   │   ├── bottle.jpg
|   │   ├── cardboard.jpg
|   │   ├── handicraft.jpg
|   │   ├── paper.jpg
|   │   ├── plastic.jpg
|   │   ├── user.jpg
│   ├── craft-backend-dev.json
│   ├── craft-backend.json
│   ├── CraftBackend.postman_environment.json
├── Prisma
│   ├── migration
│   ├── client.ts
│   ├── schema.prisma
│   ├── seed.ts
├── Public
│   ├── images
│   │   ├── Project Logo.png
├── src
│   ├── config
│   │   ├── index.ts
|   |
│   ├── controllers
│   │   ├── authController.ts
│   │   ├── dashboardController.ts
│   │   ├── detailHandicraftController.ts
│   │   ├── handicraftController.ts
│   │   ├── healthController.ts
│   │   ├── historyHandicraftController.ts
│   │   ├── imageUploadController.ts
│   │   ├── likeController.ts
│   │   ├── recognitionController.ts
│   │   ├── userController.ts
│   │   ├── wasteController.ts
│   │   ├── wasteHandicraftController.ts
|   |
│   ├── middleware
│   │   ├── authMiddleware.ts
│   │   ├── corsMiddleware.ts
│   │   ├── handicraftMiddleware.ts
│   │   ├── historyHandicraftMiddleware.ts
|   |
│   ├── routes
│   │   ├── authRoutes.ts
│   │   ├── dashboardRoutes.ts
│   │   ├── detailHandicraftRoutes.ts
│   │   ├── handicraftRoutes.ts
│   │   ├── healthRoutes.ts
│   │   ├── historyHandicraftRoutes.ts
│   │   ├── imageUploadRoutes.ts
│   │   ├── likeRoutes.ts
│   │   ├── recognitionRoutes.ts
│   │   ├── userRoutes.ts
│   │   ├── wasteRoutes.ts
|   |
│   ├── utils
│   │   ├── bucketimages.ts
│   │   ├── multer.ts
|   |
│   ├── app.ts
├── .gitignore
├── deploy.sh
├── docker-compose-dev.yml
├── docker-compose.yml
├── Dockerfile
├── express.d.ts
├── nodemon.json
├── package-lock.json
├── package-lock.json
├── readme.json
├── tsconfig.json

⚡️ Quick start

First, clone the repository:

git clone https://github.com/7exp/backend.git
cd backend

Install the necessary dependencies:

npm install

Set up the database:

npx prisma migrate deploy

Start the development server:

npm run nd:start

That's all you need to know to start! 🎉

🐳 Deployment quick start

If you want to deploy the project directly to your server, you can follow these steps: 🚀

1. Copy the docker-compose.yml file: First, you'll need to copy the docker-compose.yml file from the project's repository to your server. You can do this by running the following command on your server: 📥

wget https://raw.githubusercontent.com/7exp/backend/main/docker-compose.yml 

This will download the docker-compose.yml file from the repository to your server.

2. Configure environment variables: The project may require some environment variables to be set. You can create a .env file in the same directory as the docker-compose.yml file and add your environment variables there. For example: ⚙️

JWT_SECRET=your_secret
DATABASE_URL=mysql://user:password@db:3306/databasename
PROJECT_ID=your_GCP_project_id
BUCKET_NAME=your_GCP_bucket_name
KEYFILENAME=your_GCP_key `keyfile.json`

3. Check the ports: The docker-compose.yml file may specify ports for the containers to bind to on the host machine. Make sure that these ports are not already in use on your server. 🔍

4. Install Docker: Before you can run the docker-compose command, you'll need to make sure that Docker is installed on your server. 🐳

5. Start the containers: Once you have the docker-compose.yml file, the .env file, and Docker installed, you can start the project's containers by running the following command: 🚀

docker-compose up -d

The -d flag tells Docker to run the containers in detached mode (in the background).

This will start the server in the background. 🎉

📖 Project Wiki

Explore the extensive features and functionalities of Backend Craft It by delving into our comprehensive Wiki. Whether you're new to the project or a seasoned developer, our Wiki offers:

• Detailed Documentation: Learn about every aspect of the backend architecture, from setup to advanced features.
• API Endpoint Descriptions: Understand how to interact with various endpoints for data management and authentication.

Dive into our Wiki today to harness the full potential of Backend Craft It and transform waste materials into beautiful handicrafts seamlessly.

📜 Contributors

This project is the result of the collaborative efforts of several contributors. 💖 We appreciate the hard work and dedication of the following individuals:

Yoga Novaindra

Gymnastiar Alma Ghifari

⭐️ Activities