Skip to content

Latest commit

 

History

History
executable file
·
113 lines (87 loc) · 3.18 KB

README.md

File metadata and controls

executable file
·
113 lines (87 loc) · 3.18 KB
Raw

Place

Introduction

Place is an open-source platform for managing tickets and events, developed using the Dotnet framework. It allows event organizers to sell tickets and oversee attendees without incurring service fees from third-party ticketing providers.

Using Place, you can explore popular events nearby, receive tailored event suggestions, and see what events your friends are attending. You can also access your tickets and event details directly from your phone, tablet or pc. Discover new activities through your phone, from concerts and festivals to workshops, conferences, free events, and more.

Event organizers have the ability to monitor sales, view analytics, and handle attendee check-ins right from the app. Place provides a complete solution for event management and promotion, helping users stay informed and connected.

Installation

Prerequisites

For local development you will need:

  • .NET 9 SDK
  • Docker for running databases and containerization
  • Make for running development commands

Setup

  1. Clone the project
git clone https://github.com/osscameroon/place-api && cd place-api
  1. Restore dotnet tools
dotnet tool restore
  1. Setup husky
dotnet husky install
  1. Start the development environment
# Start databases and build the project
make dev-env

# Or start components separately:
make db-up      # Start databases only
make restore    # Restore NuGet packages
make build      # Build the solution
  1. Run tests
# Run all tests
make test

# Or run specific test types
make test-unit          # Run unit tests
make test-integration   # Run integration tests
  1. Build and run the application
# Quick build without tests
make dev

# Or full build with tests
make all

Available Make Commands

Database Management

make db-up        # Start development databases
make db-down      # Stop databases
make db-restart   # Restart databases
make db-logs      # Display database logs
make db-clean     # Remove volumes and restart databases

Build Commands

make restore      # Restore NuGet packages
make build        # Build solution
make test         # Run all tests
make publish      # Publish application
make docker       # Build Docker image
make all          # Execute restore, build, test, and docker
make clean        # Clean build files
make dev          # Quick build without tests

Development Environment

make dev-env      # Setup complete dev environment (DBs + build)
make dev-start    # Start dev environment
make dev-stop     # Stop dev environment

For more details about available commands, run:

make help

Documentation

Please refer to the documentation for more information.

Contributing

Read our contributing guidelines to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes.

License

Place is a free and open source project, released under the permissible MIT license.