Code Monkey home page Code Monkey logo

api-restaurante's Introduction

๐Ÿฅ• Restaurant API

Overview

Welcome to the Restaurant API This API allows you to manage your virtual tavern seamlessly with AdonisJS 5 and TypeScript, featuring robust table management functionalities. For development, we utilize SQLite3, while MySQL is used for production. Additionally, the API is designed with Test-Driven Development (TDD) options to ensure reliable and maintainable code.

Features

  • Table Management: Manage tables, reservations, and seating arrangements effortlessly.
  • TypeScript: Enjoy type safety and modern JavaScript features.
  • AdonisJS 5: Leverage the power of AdonisJS, a fully-featured Node.js framework.
  • SQLite3 for Development: Lightweight and easy-to-use database for local development.
  • MySQL for Production: Reliable and scalable database solution for production.
  • TDD: Implement Test-Driven Development for robust testing capabilities.

Tech Stack

  • Languages: TypeScript
  • Framework: AdonisJS 5
  • Databases: SQLite3 (development), MySQL (production)
  • Testing: TDD

Getting Started

Prerequisites

  • Node.js
  • npm or yarn
  • SQLite3 (for development)
  • MySQL (for production)

Installation

  1. Clone the repository:

    git clone https://github.com/malldonado/api-restaurante.git
    cd api-restaurante/roleplay-api
  2. Install dependencies:

    npm install
    # or
    yarn install
  3. Set up the environment variables:

    Create a .env file in the root directory and add the following variables:

    NODE_ENV=development
    APP_KEY=your_app_key
    DB_CONNECTION=sqlite
    SQLITE_FILENAME=./db.sqlite3
    MYSQL_HOST=127.0.0.1
    MYSQL_PORT=3306
    MYSQL_USER=root
    MYSQL_PASSWORD=your_mysql_password
    MYSQL_DB_NAME=restaurant
  4. Run migrations:

    node ace migration:run

Running the Development Server

Start the AdonisJS development server:

npm run dev
# or
yarn dev

Starting the Server

The server will start on http://localhost:3333.

Testing

To run tests, use the following command:

npm run test
# or
yarn test

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

  • AdonisJS
  • TypeScript
  • SQLite
  • MySQL

This README.md provides a comprehensive overview of the API, including instructions for installation, configuration, execution, and testing, as well as details about the functionalities and the technological stack used in the project.

api-restaurante's People

Contributors

malldonado avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.