Refactor

.dockerignore

@@ -0,0 +1,6 @@
+node_modules
+.dockerignore
+.gitignore
+.env.example
+README.md
+Sparrest.postman_collection.json

.eslintrc.js

@@ -0,0 +1,26 @@
+module.exports = {
+  env: {
+    commonjs: true,
+    es2021: true,
+    node: true,
+  },
+  extends: 'standard',
+  overrides: [
+    {
+      env: {
+        node: true,
+      },
+      files: ['.eslintrc.{js,cjs}'],
+      parserOptions: {
+        sourceType: 'script',
+      },
+    },
+  ],
+  parserOptions: {
+    ecmaVersion: 'latest',
+  },
+  rules: {
+    semi: [2, 'always'],
+    'comma-dangle': [2, 'only-multiline'],
+  },
+};

.gitignore

@@ -104,5 +104,6 @@ dist
 .tern-port
 
 db.json
+dbbackup.json
 public/*
 !public/.gitkeep

Dockerfile

@@ -0,0 +1,12 @@
+FROM node:21-alpine as prod-deps
+WORKDIR /app
+COPY package.json ./
+RUN npm install --omit=dev
+
+FROM node:21-alpine as prod
+WORKDIR /app
+COPY --from=prod-deps /app/node_modules ./node_modules
+COPY . .
+CMD ["npm", "start"]
+
+

README.md

@@ -1,15 +1,105 @@
-# Sparrest.js
+# Sparrest.js 2.0
 
 A [json-server](https://github.com/typicode/json-server) fork to enjoy developing frontend apps without a real backend, but with JWT auth.
 
 ## Setup
 
-1. Create a `db.json` file with the entities of your DB
-2. Run the server with `npm start` 
-3. Register a user with `POST /auth/register { username: "luke", password: "skywalker" }`
-4. Login to obtain your JWT token: `POST /auth/login { username: "luke", password: "skywalker" }`
-5. Start using `json-server` routes in `/api/<json-server routes>`. You'll need to auth every request by adding an HTTP header: `Authorization: Bearer <JWT token>`
+1. Create a `/database/db.json` file with the entities of your DB
+
+- Example with Tweets:
+  ![dbjson](https://github.com/JoseAlbDR/sparrest.js/assets/128265706/36b90cd7-666c-48ba-b5e7-7c2d003b4762)
+
+2. Create a .env file or rename the .env.example file provided to configure environment variables, if not set all variables will be created with default values as seen in `/config/index.js`file
+
+- Example .env file:
+
+```text
+ UPLOAD_FOLDER=../public/uploads
+ DB_FILE=../database/db.json
+ AUTH_READ=yes
+ AUTH_WRITE=no
+ SECRET_KEY=Annie is Vader
+ JWT_EXPIRATION=24h
+ PORT=8000
+ SALT=10
+```
+
+3. Install dependencies:
+
+```
+  npm i
+```
+
+4. Run the server with `npm start`
+
+5. Register a user with `POST /auth/register { username: "luke", password: "skywalker" }`
+
+6. Login to obtain your JWT token: `POST /auth/login { username: "luke", password: "skywalker" }`
+
+7. Start using `json-server` routes in `/api/<resource-name>`. You'll need to auth every request by adding an HTTP header: `Authorization: Bearer <JWT token>`
+
+## Docker
+
+1. Create a .env file or rename the .env.example file provided to configure environment variables.
+
+2. Run the following command to run the app in the root directory
+
+```
+  docker compose up
+```
+
+**NOTE**: folders database/db.json and public/uploads are bound to the container filesystem, any changes in the container will be reflected in the local folders but
+if you want changes done in the local folders to be reflected in the container filesystem you have to run the following command
+
+```
+  docker compose down
+  docker compose up
+```
 
 ## Uploading files
 
 You can upload files by making a multipart POST request with a file field (with file contents) to `/upload`.
+
+## Documentation
+
+- You can checout the API Documentation in `http://localhost:8000` and following the link provided or directly in `http://localhost:8000/docs`. Note that if you set a different port in .env or config files you will need to change the port accordingly.
+- In order to unlock protected routes (shown with a open padlock) you must login, copy accessToken value, click in `Authorize` button and paste it.
+- Documentation examples are done with a sample tweet Schema.
+
+## Postman
+
+- In the repo there is a file called `Sparrest.postman_collection.json` with a sample collenction wich you can directly import in Postmand and start using it right away.
+- To import the collection follow the next steps:
+
+1. Click in the top left Import button next to your workspace name:
+
+   ![import](https://github.com/JoseAlbDR/sparrest.js/assets/128265706/72eea39e-7b2b-49b2-9edd-1e55daad498c)
+
+2. Drop or select `Sparrest.postman_collection.json` and import it
+
+- Note that the collection is made with a resourche called `tweets` you can change the resource name at any time to suit your needs.
+
+## How to Use Postman Collection
+
+1. Create a user:
+
+- POST /auth/register
+  ![register](https://github.com/JoseAlbDR/sparrest.js/assets/128265706/e70a6074-7da6-45b2-821e-7ab42f4e5981)
+
+2. Login with same credentials:
+
+- POST /auth/login
+  ![login](https://github.com/JoseAlbDR/sparrest.js/assets/128265706/02c13071-b2ae-480f-8f96-3982cc797c07)
+
+3. Copy given accessToken and set and Authorization => Type: Bearer Token in protected routes:
+
+- POST /api/{resource}
+- PATCH /api/{resource}
+- DELETE /api/{resource}
+- POST /upload
+- GET /users/me
+  ![auth](https://github.com/JoseAlbDR/sparrest.js/assets/128265706/f376f2c5-a22f-4931-ace4-358698fe8626)
+
+- Optionally you can create a new Global/Environment variable, paste the token value inside and set it in all protected endpoints: Authorization => type: Bearer Token {{variableName}}
+
+Change {resource} for your resource name, per example tweets or products and freely test the API with Postman.