Git Product home page Git Product logo

vigneshguhan / restful-booker-platform Goto Github PK

View Code? Open in Web Editor NEW

This project forked from mwinteringham/restful-booker-platform

1.0 0.0 0.0 82.21 MB

A SaaS platform used for various test automation training

Home Page: http://www.automationintesting.com

License: GNU General Public License v3.0

JavaScript 33.95% HTML 0.28% Java 62.62% Shell 0.92% Batchfile 1.21% Dockerfile 0.39% SCSS 0.62%

restful-booker-platform's Introduction

restful-booker-platform

A platform of web services that forms a Bed and Breakfast booking system. The platforms primary purpose is for training others on how to explore and test web service platforms as well as strategise and implement automation in testing strategies.

Requirements

RBP is currently known to work with the following requirements:

  • JDK 14.0.1
  • Maven 3.6.3
  • Node 12.18.2
  • NPM 6.14.5

Building locally

Assuming you have the above requirements in place, to get started open a terminal/command line window and follow these instructions:

  1. Clone/Download the repository
  2. Navigate into the restful-booker-platform root folder
  3. Run either bash build_locally.sh for Linux or Mac or build_locally.cmd on Windows to build RBP and get it running (It may take a while on the first run as it downloads dependencies)
  4. Navigate to http://localhost:8080 to access the site

Running locally

Assuming you have successfully built the application at least once, you can now run the app without having to rebuild the whole application.

Mac / Linux

  1. To run without end-to-end checks run: run_locally.sh
  2. To run with end-to-end checks run: run_locally.sh -e true

Windows

  1. To run without end-to-end checks run: run_locally.cmd
  2. To run with end-to-end checks run: run_locally.cmd true

Login

The user login details are:

  • Username: admin
  • Password: password

Development

API details

The details on running checks, building APIs and additional details on documentation for development can be found in READMEs inside each of the API folders.

Setting up your own CI/CD for this project

The build process for this project is managed by CircleCI which is all managed by the config.yml file in the .circleci folder. To get setup you will need to:

Running CI tests

Follow these steps to get a CI setup running the tests

  1. Fork this repository so that you have your own copy
  2. If you haven't already, create a CircleCI login using your GitHub details. This will connect CircleCI to your GitHub profile.
  3. Head to the Projects page in CircleCI, locate the RBP repository and click setup project.
  4. Go through the steps to for setting up the project, ensuring that it loads in the config.yml from the project (Click use existing config)

If you would like to setup CircleCI to run a full deployment, please drop an issue into the repository.

restful-booker-platform's People

Contributors

ardesco avatar dependabot[bot] avatar friendlytester avatar jvsanten avatar mwinteringham avatar ollyjshaw avatar testingchef avatar

Stargazers

 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.