⚙ Dogs API, an API made with Express for Dogs 🐶

📖 About

This is an API made with Express for 🐶 Dogs 🐶, the Instagram for dogs. I suggest, if you didn't already, check out that first, then comeback here so you can see how the API works.

This API was made in replacement of the original API from the Origamid's course, which was made with WordPress. This one is made with Node.js, Express and more.

---

🌎 Online!

This API is online at this moment!
Deploy made in Heroku 🟪!

🗺 Check out the API routes here:

• 🏠 home: /

• 👥 users: /users

  • [POST] Store - /users

    {
      "username": "username",
      "email": "email@example.com",
      "password": "password"
    }

  • [GET] Show - /users (login required)

  • [PUT] Update - /users (login required)

    {
      "username": "username",
      "email": "email@example.com",
      "password": "password"
    }

  • [DELETE] Delete - /users (login required)

• 🖼 photos: /photos

  • [GET] Index - /photos

  • [GET] Show - /photos/:id

  • [POST] Store - /photos (login required)

    {
      "title": "Ex: Dog's name",
      "src": <file>,
      "weight": 7,
      "age": 2
    }

  • [DELETE] Delete - /photos/:id (login required)

• 📝 comments: /comments

  • [GET] Show - /comments/:id

  • [POST] Store - /comments/:id (login required)

    {
      "comment_content": "Ex: This is a comment"
    }

• 🔐 tokens: /tokens

  • [POST] Store - /tokens

    {
      "username": "username",
      "password": "password"
    }

---

🧪 Technologies

This project was developed using the following technologies:

---

🚀 Usage

To run this API locally, you'll need Node.js installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/abacaxiguy/dogs_api.git

# Go into the repository
$ cd dogs_api

# Install dependencies
$ npm install # yarn or pnpm

# Run the app
$ npm start # yarn or pnpm

🎉 Congratulations, the API is running in http://localhost:{APP_PORT} (default: http://localhost:3000)!

⚠ Remember to fill the APP_PORT and the others fields in the .env file, following the .env.example file ⚠

---

📋 API Documentation

You can check the API documentation in Insomnia here:

---

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

---

📋 Tested in

• Windows 10 ✅
• Linux [Ubuntu 18.04.4 LTS] ✅

---

Developed by 🍍