Node/AdonisJS API for Articles

  • This API is developed to create users and users can create articles.

  • The endpoints:

    • User routes
      • Get all users: get "/users"
      • Get one user: get "/users/:id"
      • Create a user: post "/users"
      • Update a user: put "/users/:id"
      • Delete a user: delete "/users/:id
    • Article routes
      • Get all users information with articles: get "/api/all"
      • Get all articles: get "/api/articles"
      • Get one article: get "/api/articles/:id"
      • Create an article: post "/api/articles"
      • Update an article: put "/api/articles/:id"
      • Delete an article: delete "/api/articles/:id

Built with

  • Javascript,
  • NodeJS,
  • AdonisJS,
  • Mysql.

Getting Started

  • Clone the repo git@github.com:necmigunduz/articles-server-adonis-node.git,
  • cd cd articles-server-adonis-node the project,
  • install dependencies npm install,
  • create a .env file in the root folder and add your environment variables including the followings: ,
        APP_KEY=**********************
        APP_NAME=*************
        APP_NAMESPACE=**************
        APP_URL=************
        CACHE_VIEWS=*************
        DATABASE_URL=************
        DB_CONNECTION=**************
        DB_DATABASE=*******************
        DB_HOST=*************
        DB_PASSWORD=*************
        DB_PORT=****
        HASH_DRIVER=**********
        HOST=******
        NODE_ENV=*********
        PORT=****
    
  • Install Mysql server, create a user, create a database, add their information to .env file, and start Mysql server locally, (You can use other SQL or NoSQL servers),
  • start the project npm run start,
  • for production npm run build.

Authors

👤 Necmi Gunduz

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

👏 Acknowledgements

📝 License

MIT License