README.md

Tiko Energy

The coding challenge for the senior backend engineer role by Tiko.

Table of Contents

1. Introduction
2. Features
3. Requirements
4. Installation
5. Usage
6. Testing
7. Code coverage
8. Linting
9. API Documentation

Introduction

This is an Event manager app which allow organisers to create and manage events and allow users to attend the events.

Features

• Users can register an account using Email and password.
• Users can log in to get access token and refresh token.
• Access token with lifetime of 1 hour.
• Refresh token with lifetime of 1 day.
• Users can Create event after login.
• Users can Update only events they have created.
• Users can list all events.
• Users can filter events by owner and other fields.
• Users can cancel only events they have created.
• Users can subscribe or unsubscribe to events
• Events have validation
• Users can not subscribe to event if max limit reach
• New line

Requirements

Requirements can be found in the requirements.txt file

Installation

1. Create venv and Clone the repository:

   mkdir project
   cd project 
   python3.11 -m venv venv 
   source venv/bin/activate
   git clone https://github.com/hashaaamm/tiko_energy.git
   cd tiko_energy

2. Install dependencies:

   pip3 install -r requirements.txt

3. Run migrations:

   python manage.py makemigrations 
   python manage.py migrate

Usage

1. Create superuser:

   python manage.py createsuperuser 

2. Start the server:

   python manage.py runserver

3. Access admin at http://127.0.0.1:8000/admin/

Testing

1. Run Test:

   pytest

Code coverage

1. To check coverage:

   pytest -p no:warnings --cov=.

Linting

1. To check coverage:

   flake8 .
   black .
   isort .

API Documentation

1. Access API docs at http://127.0.0.1:8000/api/swagger-docs/