Initial commit

Author: thelostone-mc

.env.example

@@ -0,0 +1,6 @@
+DATABASE_URL=postgresql://username:password@localhost:5432/retrofunding
+SYNCHRONIZE=false
+LOGGING=true
+PORT=4000
+INDEXER_URL=https://grants-stack-indexer-v2.gitcoin.co/
+NODE_ENV=development

.eslintignore

@@ -0,0 +1,3 @@
+build/
+node_modules/
+src/index.ts

.eslintrc.json

@@ -0,0 +1,15 @@
+{
+  "env": {
+    "node": true,
+    "es2021": true
+  },
+  "extends": [
+    "standard-with-typescript",
+    "prettier"
+  ],
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "rules": {}
+}

.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: CI Pipeline
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the repository
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      # Set up Node.js
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      # Install dependencies
+      - name: Install dependencies
+        run: npm install
+
+      # Run linting
+      - name: Run ESLint
+        run: npm run lint
+
+      # Check formatting with Prettier
+      - name: Check Prettier formatting
+        run: npm run prettier -- --check
+
+      # Run the build
+      - name: Run build
+        run: npm run build

.gitignore

@@ -0,0 +1,10 @@
+.idea/
+.vscode/
+node_modules/
+build/
+tmp/
+temp/
+logs/
+.env
+.eslintcache
+schema.graphql

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.prettierignore

@@ -0,0 +1 @@
+src/migration

.prettierrc.json

@@ -0,0 +1,11 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "bracketSpacing": true,
+  "arrowParens": "avoid",
+  "endOfLine": "lf"
+}

README.md

@@ -0,0 +1,67 @@
+# retrofunding-api
+
+## Structure
+
+```
+.
+├── README.md                   # Project documentation
+├── package-lock.json           # Dependency lock file
+├── package.json                # Project metadata and dependencies
+├── src                         # Source code for the application
+│   ├── controller              # Routing controller logic
+│   ├── entity                  # TypeORM entities, defining database schemas and relations
+│   ├── ext                     # External API integrations
+│   ├── migration               # Database migrations for schema changes
+│   ├── routes                  # API routes
+│   ├── service                 # Business logic and service functions
+│   ├── data-source.ts          # Database connection setup and configuration
+│   ├── index.ts                # Application entry point
+│   ├── postgraphile.config.ts  # Postgraphile configuration
+│   ├── repository.ts           # Repositories for data access logic
+│   ├── swagger.ts              # Optional: Swagger setup in TypeScript
+│   └── utils.ts                # Utility functions and helper methods
+└── tsconfig.json               # TypeScript configuration
+```
+
+## Getting Started
+
+1. **Basic Setup**:
+   ```bash
+   npm install
+   npm run prepare
+   ```
+2. **Configure Environment Variables**:
+   Create a `.env` file in the root of the project and set the necessary environment variables for database connection.
+3. **Setting up your databas**:
+- Connect as admin `psql -U your_admin_username -h your_database_host -p your_database_port`
+- In `psql` shell, run
+  ```shell
+  CREATE DATABASE your_database_name;
+  CREATE ROLE your_database_username WITH LOGIN PASSWORD 'your_database_password';
+  GRANT ALL PRIVILEGES ON DATABASE your_database_name TO your_database_username;
+  ```
+4. **Handling Migration**
+- Make changes to the entity
+- Generate migration with `npm run generate --name=MigrationName`
+- Run migration with `npm run migrate`
+- If you need to revert last migration, `npm run revert`
+5. **Run the Development Server**:
+   ```bash
+   npm run dev
+   ```
+6. **API Overview**
+  - Visit `http://localhost:3000/api-docs`
+
+**Note**
+
+- For [Logging.md](./src//logger/logger.md) to understand use winston for logging
+- For Try catch handling done via [catchError](./src/utils.ts)
+- All routes are documented using [swagger](./src/swagger.ts)
+- Postgraphile endpoint is hosted at `http://localhost:3000/graphiql`
+
+```
+POST Endpoint
+------
+router.post('/pools', syncPool);
+router.post('/allocations', allocations)
+```