user-register

Basic API with user register feature, you can try out with insomnia

🚧 Caution: Not finished yet 🚧

Features • Get Started • Run • Debug • Test it • Technologies • Styleguides • Author

✔️ Features

• User Register
• Authenticate session
• User update
• User delete
• User index
• User list
• Tests

🏁 Get started

Install: Git, Node.js.

I recommend the use of VSCode as IDE: VSCode

▶️ Run

# Clone it
$ git clone <https://github.com/araujoizabelle/user-register>

# On your cmd/bash
$ cd user-register

# Install the packages
$ npm install

# Run as development
$ npm run dev

# It will start at port:3333 - go for it! <http://localhost:3333>

🪲 Debug

# To debug the application correctly I recommend you:
    1 - Add a new configuration on your VSCode
    2 - You can follow mine - index.js is where our server.js is started! 
         {  "configurations": [
              {
                "type": "node",
                "request": "launch",
                "name": "Launch Program",
                "skipFiles": [
                  "<node_internals>/**"
                ],
                "program": "${workspaceFolder}/index.js"
              }
            ]
          }

$ npm run dev:debug

📨 Test it

Insomnia See import and export request on insomnia

  With insomnia you can test the api whitout a frontend
  Just download the json file I left in the code, and import on insomnia
  
  If you want to, you can write more tests on the test folder 
  $ npm run test
  

⚙️ Technologies

• Node.js
• Nodemon
• Sucrase
• Sequelize - see the seeds sections too!
• Mysql
• Express
• Celebrate
• Bcrypt
• JWT
• Jest
• Supertest

📖 Styleguides

Remember to install the VSCode plugins

• Prettier
• Eslint - Air bnb

Made with 💜 by Izabelle