{"id":18938281,"url":"https://github.com/getange/xata-t2g","last_synced_at":"2025-04-15T19:30:23.577Z","repository":{"id":257920174,"uuid":"872539822","full_name":"GETANGE/XATA-T2G","owner":"GETANGE","description":"This repository contains a project that we worked on as a group as part of the Teach2Give program bootcamp","archived":false,"fork":false,"pushed_at":"2024-10-24T18:34:21.000Z","size":992,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-29T01:12:15.528Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GETANGE.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-14T15:59:45.000Z","updated_at":"2024-11-11T07:25:52.000Z","dependencies_parsed_at":"2024-10-24T22:45:46.281Z","dependency_job_id":null,"html_url":"https://github.com/GETANGE/XATA-T2G","commit_stats":null,"previous_names":["getange/xata-t2g"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GETANGE%2FXATA-T2G","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GETANGE%2FXATA-T2G/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GETANGE%2FXATA-T2G/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GETANGE%2FXATA-T2G/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GETANGE","download_url":"https://codeload.github.com/GETANGE/XATA-T2G/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249138502,"owners_count":21218898,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T12:13:57.789Z","updated_at":"2025-04-15T19:30:23.240Z","avatar_url":"https://github.com/GETANGE.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🌟 Task Manager\n\n## 📝 Overview\n\nThis project is a web application where users can create and manage projects. It involves a backend built with **Express.js**, a frontend built with **React**, and **Xata** as the database solution. This README will guide you through setting up and running the project from scratch.\n\n## 📑 Table of Contents\n\n1. [Prerequisites](#prerequisites)\n2. [Project Setup](#project-setup)\n   - [Backend (Express)](#backend-express)\n   - [Database (Xata)](#database-xata)\n   - [Frontend (React)](#frontend-react)\n3. [Running the Project](#running-the-project)\n4. [API Documentation](#api-documentation)\n5. [Environment Variables](#environment-variables)\n6. [Technologies Used](#technologies-used)\n7. [Contributing](#contributing)\n\n---\n\n## 🔧 Prerequisites\n\nBefore you begin, ensure you have the following installed:\n\n- **Node.js**: [Download](https://nodejs.org/) 🌍\n- **npm** or **pnpm**: Comes with Node.js, but you can install [pnpm](https://pnpm.io/) as an alternative package manager 🚀\n- **Xata CLI**: [Installation Guide](https://xata.io/docs/cli/install) 🛠️\n- **Git**: [Download](https://git-scm.com/) 🧑‍💻\n\n---\n\n## ⚙️ Project Setup\n\n### 🔙 Backend (Express)\n\n1. **Clone the repository**:\n   ```bash\n   git clone \u003cyour-repo-url\u003e 📦\n   cd \u003cyour-project-directory\u003e 🗂️\n2. **Install all dependencies**:\n    ```bash\n    Copy code\n    pnpm install   # or npm install\n    Set up environment variables: In the root of the project directory, create a .env file and add the following:\n\n    bash\n    Copy code\n    PORT=5000\n    DATABASE_URL=\u003cyour-xata-database-url\u003e\n    Run the backend server:\n    \n    bash\n    Copy code\n    pnpm run dev   # or npm run dev\n    The backend server will start at http://localhost:5000.\n\n3. **💽 Database (Xata)**:\n   ```bash\n    Install the Xata CLI:\n\n    bash\n    Copy code\n    pnpm add -g @xata.io/cli   # or npm install -g @xata.io/cli\n    Login to Xata:\n    \n    bash\n    Copy code\n    xata auth login\n    Set up your database:\n    \n    bash\n    Copy code\n    xata init\n    Push your schema to Xata:\n    \n    bash\n    Copy code\n    xata push\n4. **🖥️ Frontend (React)**:\n   ```bash\n    Navigate to the frontend directory:\n\n    bash\n    Copy code\n    cd ../frontend\n    Install frontend dependencies:\n    \n    bash\n    Copy code\n    pnpm install   # or npm install\n    Set up environment variables: In the frontend directory, create a .env file and add your backend URL:\n    \n    bash\n    Copy code\n    REACT_APP_BACKEND_URL=http://localhost:5000\n    Run the React app:\n    \n    bash\n    Copy code\n    pnpm run start   # or npm run start\n    This will start the React app on http://localhost:3000.\n\n3. **🏃 Running the Project**:\n   ```bash\n    Start the Backend: Navigate to the backend folder and run:\n    \n    bash\n    Copy code\n    pnpm run dev   # or npm run dev\n    Start the Frontend: Navigate to the frontend folder and run:\n    \n    bash\n    Copy code\n    pnpm run start   # or npm run start\n    Now both the frontend and backend should be running, and you can access the application at http://localhost:3000.\n\n4. **📖 API Documentation**:\n   ```bash\n    POST /api/v1/project: Create a new project\n    GET /api/v1/project: Retrieve all projects\n    PATCH /api/v1/project/:id: Update a project\n    DELETE /api/v1/project/:id: Delete a project\n   \n       POST /api/v1/teams: Create a new project\n    GET /api/v1/teams: Retrieve all projects\n    PATCH /api/v1/teams/:id: Update a project\n    DELETE /api/v1/teams/:id: Delete a project\n\n       POST /api/v1/task: Create a new project\n    GET /api/v1/task: Retrieve all projects\n    PATCH /api/v1/task/:id: Update a project\n    DELETE /api/v1/project/:id: Delete a project\n\n       POST /api/v1/comments: Create a new project\n    GET /api/v1/comments: Retrieve all projects\n    PATCH /api/v1/comments/:id: Update a project\n    DELETE /api/v1/comments/:id: Delete a project\n   \n5. **🌐 Environment Variables**:\n    ```bash\n      PORT: The port on which the backend server will run (default: 5000).\n      DATABASE_URL: Your Xata database connection URL.\n      REACT_APP_BACKEND_URL: The URL of your backend server for the frontend app to communicate with.\n🛠️ Technologies Used\n\n        Backend: Express.js\n        Frontend: React.js\n        Database: Xata\n        Package Manager: pnpm (or npm)\n🤝 Contributing\nContributions are welcome! Feel free to open a Pull Request or create an issue if you find any bugs or have suggestions for improvements.\n\nFork the project\nCreate your feature branch (git checkout -b feature/your-feature-name)\nCommit your changes (git commit -am 'Add some feature')\nPush to the branch (git push origin feature/your-feature-name)\nOpen a Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetange%2Fxata-t2g","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetange%2Fxata-t2g","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetange%2Fxata-t2g/lists"}