Merge pull request #70 from wajeht/feature/maintenance

feature/maintenance

.env.example

@@ -1,5 +1,5 @@
 # app
-PORT=8082
+PORT=80
 ENV="development"
 DOMAIN="https://close-powerlifting.jaw.dev"
 MONGODB_URI="mongodb://username:password@mongodb:27017/close-powerlifting?authSource=admin" # docker

.github/workflows/ci.yml

@@ -6,7 +6,7 @@ on:
   pull_request:
 
 env:
-  PORT: 8080
+  PORT: 80
   ENV: 'testing'
   DOMAIN: 'https://close-powerlifting.jaw.dev'
   PASSWORD_SALT: 5
@@ -105,9 +105,12 @@ jobs:
 
   deploy:
     needs: [format, test, lint]
-    name: Deploy to caprover
+    name: Deploy to production
     runs-on: ubuntu-latest
     if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    environment:
+      name: production
+      url: https://close-powerlifting.jaw.dev/
 
     steps:
       - name: Check out repository
@@ -134,7 +137,7 @@ jobs:
           push: true
           tags: ${{ env.IMAGE_URL }}
 
-      - name: Deploy Image to CapRrover
+      - name: Deploy Image to Production
         uses: caprover/[email protected]
         with:
           server: '${{ secrets.CAPROVER_SERVER }}'

.vscode/settings.json

@@ -14,10 +14,12 @@
     "multistream",
     "openpowerlifting",
     "pino",
+    "powerlifing",
     "powerlifting",
     "resave",
     "tailwindcss",
     "unhashed",
+    "uspa",
     "wajeht"
   ],
   "dotenv.enableAutocloaking": false

Dockerfile.dev

@@ -13,8 +13,8 @@ COPY ./ ./
 
 RUN npm install
 
-EXPOSE 8082
+EXPOSE 80
 
 CMD ["npm", "run", "dev"]
 
-HEALTHCHECK CMD curl -f http://localhost:8082/api/health-check || exit 1
+HEALTHCHECK CMD curl -f http://localhost:80/api/health-check || exit 1

Dockerfile.prod

@@ -18,8 +18,8 @@ RUN npm install
 RUN npm run build
 # RUN npm run minify:html
 
-EXPOSE 8082
+EXPOSE 80
 
 CMD ["npm", "run", "start"]
 
-HEALTHCHECK CMD curl -f http://localhost:8082/api/health-check || exit 1
+HEALTHCHECK CMD curl -f http://localhost:80/api/health-check || exit 1

README.md

@@ -1,12 +1,10 @@
-# <div align="center"> 🏋🏻 Close Powerlifting </div>
+# 🏋🏻 Close Powerlifting
 
-<div align="center">
+[![Node.js CI](https://github.com/wajeht/close-powerlifting/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/wajeht/close-powerlifting/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/ISC)
+[![Open Source Love svg1](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/allkindsofgains/gains)
 
-[![Node.js CI](https://github.com/wajeht/close-powerlifting/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/wajeht/close-powerlifting/actions/workflows/ci.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/ISC) [![Open Source Love svg1](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/allkindsofgains/gains)
-
-</div>
-
-<p align="center"> an intuitive api for open-powerlifting database </p>
+an intuitive api for open-powerlifting database
 
 # 📚 Technologies
 

docker-compose.dev.yml

@@ -7,7 +7,7 @@ services:
       context: ./
       dockerfile: ./Dockerfile.dev
     ports:
-      - '8082:8082'
+      - '80:80'
     volumes:
       - ./:/usr/src/app
       - /usr/src/app/node_modules
@@ -31,7 +31,7 @@ services:
 
   mongodb:
     container_name: mongodb
-    image: mongo:latest
+    image: mongo:4
     restart: unless-stopped
     environment:
       MONGO_INITDB_ROOT_USERNAME: username

docs/getting-started.md

@@ -0,0 +1,30 @@
+# Getting Started
+Clone the repository
+
+```bash
+$ git clone https://github.com/wajeht/close-powerlifting.git
+```
+
+Copy `.env.example` to `.env`
+
+```bash
+$ cp .env.example .env
+```
+
+Install dependencies
+
+```bash
+$ npm install
+```
+
+Run development server
+
+```bash
+$ npm run dev
+```
+
+Test the application
+
+```bash
+$ npm run test
+```

src/api/federations/federations.routes.ts

@@ -34,7 +34,7 @@ federations.get(
  * @tags federations
  * @summary get list of federations of a federation by year
  * @param {string} federation.path.required - the federation - application/x-www-form-urlencoded
- * @param {number} year.query - the yeare - application/x-www-form-urlencoded
+ * @param {number} year.query - the year - application/x-www-form-urlencoded
  * @param {boolean} cache.query - the cache - application/x-www-form-urlencoded
  * @security BearerAuth
  */

src/api/health-check/health-check.services.ts

@@ -47,7 +47,7 @@ export async function getAPIStatus({ X_API_KEY, url }: { X_API_KEY: string; url:
     return data;
   };
 
-  const cacheKey = `close-powerlifting-gloabl-status-call-cache`;
+  const cacheKey = `close-powerlifting-global-status-call-cache`;
 
   // @ts-ignore
   let data = JSON.parse(await redis.get(cacheKey));

src/api/meets/meets.services.ts

@@ -35,15 +35,15 @@ export async function getMeet({ meet, cache = true }: getMeetParamType & getMeet
     }
 
     // @ts-ignore
-    let cachedMeeet = JSON.parse(await redis.get(`meet-${meet}`));
+    let cachedMeet = JSON.parse(await redis.get(`meet-${meet}`));
 
-    if (!cachedMeeet) {
-      cachedMeeet = await fetchMeet({ meet });
+    if (!cachedMeet) {
+      cachedMeet = await fetchMeet({ meet });
       // @ts-ignore
-      await redis.set(`meet-${meet}`, JSON.stringify(cachedMeeet));
+      await redis.set(`meet-${meet}`, JSON.stringify(cachedMeet));
     }
 
-    return cachedMeeet;
+    return cachedMeet;
   } catch (error) {
     if (error instanceof AxiosError) {
       if (error.response?.status === StatusCodes.NOT_FOUND) {

src/app.ts

@@ -65,7 +65,7 @@ if (ENV === ENV_ENUMS.PRODUCTION) {
 
 app.use(
   express.static(path.resolve(path.join(process.cwd(), 'public')), {
-    // 30 days in miliseconds
+    // 30 days in milliseconds
     maxAge: 30 * 24 * 60 * 60 * 1000,
   }),
 );