Adonisjs (A Nodejs framework) Ready-to-use API TDD Project Structure

A ready-to-use boilerplate for REST API Development with Adonisjs, Node.js, TDD and SQL Lite.

Getting started

This is a basic API skeleton written in JavaScript ES2015. Very useful to building a RESTful web APIs for your front-end platforms like Android, iOS or JavaScript frameworks (Angular, Reactjs, etc).

This project will run on NodeJs using SQL Lite as database. I had tried to maintain the code structure easy as any beginner can also adopt the flow and start building an API. Project is open for suggestions, Bug reports and pull requests.

Software Requirements

• Node.js 16+

How to install

Using Git (recommended)

1. Clone the project from github. Change "myproject" to your project name.

git clone https://github.com/jaymistry4/adonisjs-webapi-tdd ./myproject

Using manual download ZIP

1. Download repository

2. Uncompress to your desired directory

Install npm dependencies after installing (Git or manual download)

cd myproject

npm install

How to run the project

Using CMD (recommended)

Run following commands to get started

node ace serve --watch

Bugs or improvements

Every project needs improvements, Feel free to report any bugs or improvements. Pull requests are always welcome.

License

This project is open-sourced software licensed under the MIT License. See the LICENSE file for more information.