feat: .env instead of config.js

Author: vadympop

.env.template

@@ -0,0 +1,18 @@
+MONGO_USERNAME=''
+MONGO_PASSWORD=''
+MONGO_CLUSTER=''
+MONGO_DATABASE=''
+
+JWT_ACCESS_SECRET='super secret'
+JWT_REFRESH_SECRET='super secret'
+
+API_PORT=5000
+API_URL='http://localhost:5000'
+CLIENT_URL='http://localhost:3000'
+APP_NAME='NotesAPP'
+
+MAIL_USER='[email protected]'
+MAIL_FROM='[email protected]'
+MAIL_PASSWORD=''
+MAIL_PORT=
+MAIL_HOST=''

.gitignore

@@ -57,4 +57,4 @@ profile*
 *clinic*
 *flamegraph*
 
-config.js
+.env

README.md

@@ -1,41 +1,50 @@
 # NotesAPP API
 
 ## Installation
+
 1. Firstly, clone the repository
+
 ```
 git clone https://github.com/VadyChel/NotesAppAPI.git
 ```
 
 ...and change directory to cloned
+
 ```
 cd NotesAppAPI
 ```
 
 2. Install dependencies
+
 ```
 npm i
 ```
 
 ...or if you want dev dependencies
+
 ```
 npm i -D
 ```
 
 3. Run server
+
 ```
 npm run start
 ```
 
 ...or in dev mode
+
 ```
 npm run dev
 ```
 
 **For test executing**
+
 ```
 npm run test
 ```
 
 ## Application settings
-1. Create file `config.js` and move to them `config.template.js` content
-2. Put your data into `config.js` variables
+
+1. Create file `.env` and move to them `.env.template` content
+2. Put your data into `.env` variables

app.js

@@ -5,8 +5,10 @@ import fastifyFormBody from '@fastify/formbody'
 import fastifyCORS from '@fastify/cors'
 import ajvCompiler from '@fastify/ajv-compiler'
 import Fastify from 'fastify'
-import { API_PORT } from './config.js'
 import fastifyCookie from '@fastify/cookie'
+import { config } from 'dotenv'
+
+config()
 
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = path.dirname(__filename)
@@ -41,7 +43,7 @@ app.register(fastifyCORS)
 app.register(fastifyFormBody)
 
 try {
-  await app.listen(API_PORT)
+  await app.listen(process.env.API_PORT)
 } catch(e) {
   console.log(e)
   process.exit()

config.template.js

@@ -1,5 +1,4 @@
 import UsersService from '../services/users.js'
-import { CLIENT_URL } from '../config.js'
 
 class UsersController {
   async getCurrentUser(req, rep) {
@@ -10,7 +9,7 @@ class UsersController {
     try {
       await UsersService.activateUser(req.params.code)
     } finally {
-      rep.redirect(CLIENT_URL)
+      rep.redirect(process.env.CLIENT_URL)
     }
   }
 }

controllers/users.js

@@ -30,6 +30,7 @@
     "@fastify/cors": "^7.0.0",
     "@fastify/formbody": "^6.0.0",
     "bcrypt": "^5.0.1",
+    "dotenv": "^16.0.1",
     "fastify": "^3.0.0",
     "fastify-autoload": "^3.10.0",
     "fastify-plugin": "^3.0.0",

package-lock.json

@@ -1,16 +1,15 @@
 import fastifyPlugin from 'fastify-plugin'
-import { MONGO_CLUSTER, MONGO_DATABASE, MONGO_PASSWORD, MONGO_USERNAME } from '../config.js'
 import mongoose from 'mongoose'
 
 export default fastifyPlugin(async (fastify, options) => {
   mongoose.connection.on('connect', () => {
-    fastify.log.info(`MongoDB connected with user ${MONGO_USERNAME} on ${MONGO_DATABASE} database`)
+    fastify.log.info(`MongoDB connected with user ${process.env.MONGO_USERNAME} on ${process.env.MONGO_DATABASE} database`)
   })
   mongoose.connection.on('disconnect', () => {
     fastify.log.info('MongoDB disconnected')
   })
   try {
-    await mongoose.connect(`mongodb+srv://${MONGO_USERNAME}:${MONGO_PASSWORD}@${MONGO_CLUSTER}/${MONGO_DATABASE}?retryWrites=true&w=majority`)
+    await mongoose.connect(`mongodb+srv://${process.env.MONGO_USERNAME}:${process.env.MONGO_PASSWORD}@${process.env.MONGO_CLUSTER}/${process.env.MONGO_DATABASE}?retryWrites=true&w=majority`)
   } catch(e) {
     fastify.log.error(`Mongo error: ${e}`)
   }

package.json

@@ -3,7 +3,6 @@ import bcrypt from 'bcrypt'
 import MailService from '../services/mails.js'
 import UsersService from '../services/users.js'
 import TokensService from '../services/tokens.js'
-import { API_URL } from '../config.js'
 import { v4 as uuid4 } from 'uuid'
 import ActivationMails from '../database/models/activationMails.js'
 
@@ -35,7 +34,7 @@ class AuthService {
     const passwordHash = await bcrypt.hash(password, 8)
     const activationCode = uuid4()
     const userId = uuid4()
-    const activationLink = `${API_URL}/api/users/activate/${activationCode}`
+    const activationLink = `${process.env.API_URL}/api/users/activate/${activationCode}`
 
     await ActivationMails.create({ userId, activationCode })
     await Auth.create({ passwordHash, email, userId, username })