CahBantul / address-conversion-api-with-adonisjs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This is my result for assessment test in PT. Kasir Pintar International.

(back to top)

Built With

This address conversion api build with :

(back to top)

Getting Started

This is an instructions on setting up project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

List things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g
  • adonis cli
    npm install @adonisjs/cli -g
    for make sure you installed it, check with
    adonis --version

Installation

  1. Clone the repo and enter the directory

    git clone https://github.com/CahBantul/address-conversion-api-with-adonisjs.git && cd address-conversion-api-with-adonisjs
  2. Install NPM packages

    npm install
  3. rename file .env.sample become .env. I use the default configuration note : if the APP_KEY doesn't exit, you can use command below

    adonis key:generate
  4. migrating database

    adonis migration:run
  5. seeding data dummy for user

    adonis seed

    after run it, two user adding in the database. For information the users you can see it in the log

    [
      {
        id: 1,
        username: "usersatu",
        email: "user1@gmail.com",
        password: "$2a$10$iU9hgCpOMF16tjUH5Xufaubp3fkPInni0NSrgW1i82p7/MTCtFA42",
        created_at: "2022-07-01 13:26:33",
        updated_at: "2022-07-01 13:26:33",
      },
      {
        id: 2,
        username: "userdua",
        email: "user2@gmail.com",
        password: "$2a$10$4260QSjXGNlHH5sm4XzWGuU4mGCbEmpuQDkEuNJgUn32pg83nGTYS",
        created_at: "2022-07-01 13:26:35",
        updated_at: "2022-07-01 13:26:35",
      },
    ];
  6. run the app

    adonis serve --dev

    the app running on http://127.0.0.1:3333

    (back to top)

Usage

For postman documentation of this api please refer to the Documentation

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

Your Name - @fardannozami

Project Link: https://github.com/CahBantul/address-conversion-api-with-adonisjs.git

(back to top)

Acknowledgments

List resources helpful and I would like to give credit to.

(back to top)

About


Languages

Language:JavaScript 99.2%Language:Shell 0.8%