Giter VIP home page Giter VIP logo

pass-in's Introduction

Pass.In API

Java Spring

This project is an API built using Java, Java Spring, Flyway Migrations, HSQLDB as the database.

This project simulates the operation of an in-person event management dashboard, built during Next Level Week Unite, a free event where I built the project from scratch to teach the community of developers starting in the area.

Table of Contents

Requirements

Functional requirements

  • The organizer must be able to register a new event.
  • The organizer must be able to view event data.
  • The organizer must be able to view the list of participants.
  • The participant must be able to register for an event.
  • The participant must be able to view their registration badge.
  • The participant must be able to check-in at the event.

Business rules

  • Participants can only register for an event once.
  • Participants can only register for events with available places.
  • Participants can only check-in to an event once.

Non-functional requirements

  • Check-in at the event will be carried out using a QRCode.

Installation

  1. Clone the repository:
git clone https://github.com/Fernanda-Kipper/pass-in.git
  1. Install dependencies with Maven

Usage

  1. Start the application with Maven
  2. The API will be accessible at http://localhost:8080

API Endpoints

The API provides the following endpoints:

POST /events - Register a new event.

GET /events/{eventId} - Retrieve event details.

GET /events/attendees/{eventId} - Retrieve the list of participants registered for specified event.

POST /events/{eventId}/attendees - Register a new participant to event.

POST /attendees/{attendeeId}/badge - Retrieves participant badge to access the event.

POST /attendees/{attendeeId}/check-in - Check in participant in the event.

pass-in's People

Contributors

fernanda-kipper avatar

Stargazers

 avatar  avatar  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.