Code Monkey home page Code Monkey logo

code4good's Introduction

Code4Good

Code4Good is a collaborative platform for developing non-profit web applications aimed at solving social issues and supporting NGOs. Users can suggest ideas, form development teams, and turn those ideas into complete projects.

Technologies Used

  • Frontend: React with Vite
  • Backend: Node.js with Express
  • Database: PostgreSQL
  • Containerization: Docker and Docker Compose

Project Structure

code4good/
├── backend/
│   ├── Dockerfile
│   ├── src/
│   │   ├── app.js
│   │   ├── controllers/
│   │   ├── routes/
│   │   └── config/
│   └── package.json
├── frontend/
│   ├── Dockerfile
│   ├── src/
│   │   ├── components/
│   │   ├── pages/
│   │   ├── App.jsx
│   │   ├── index.jsx
│   └── package.json
└── docker-compose.yml

Setup Instructions

Prerequisites

  • Docker and Docker Compose installed on your system.

Steps

  1. Clone the repository:

    git clone <REPOSITORY_URL>
    cd code4good
  2. Build and start the containers:

    docker-compose up --build

Access the Application

Key Features

Backend

  • API Endpoints:
    • GET /api/users: Retrieve all users.
    • POST /api/users: Create a new user.

Frontend

  • Create User Form: Form to create a new user and submit the data to the backend.

Initial Database Setup

database/init.sql:

CREATE TABLE users (
  id SERIAL PRIMARY KEY,
  name VARCHAR(100),
  email VARCHAR(100) UNIQUE
);

CREATE TABLE ideas (
  id SERIAL PRIMARY KEY,
  title VARCHAR(100),
  description TEXT,
  user_id INT REFERENCES users(id)
);

CREATE TABLE projects (
  id SERIAL PRIMARY KEY,
  name VARCHAR(100),
  idea_id INT REFERENCES ideas(id)
);

CREATE TABLE tasks (
  id SERIAL PRIMARY KEY,
  description TEXT,
  project_id INT REFERENCES projects(id)
);

Contributions

Contributions are welcome! Please fork the repository and submit a pull request.

License

This project is licensed under the MIT License.

Contact

For any inquiries or issues, please contact [[email protected]].

code4good's People

Contributors

carl0sfelipe avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.