Code Monkey home page Code Monkey logo

backend-1's Introduction

What is this Application ? ๐Ÿค”

This Application is an online registration, user-data management and QR entry framework created for IIT Patna's annual cultural Festival Awesha. The primary objective is to provide an easily deployable and highly scalable framework for online registration that anyone can set up easily. It is built on Django and offers a comprehensive set of REST APIs for registration, user data management, entry management and more.

The framework is designed to be flexible and compatible with various client applications. We have successfully used it during our university's annual festival in 2023, serving over 3000 users simultaneously through a web frontend and Android app.

Currently, the framework is compatible with AWS S3, utilising SQL databases.But cloud storage is not compulsory to use ,it can use local storage as well.

Steps for running ๐Ÿ’ป

โ— application requires some initial configurations so please read configuration related files first.

  • create virtual env --> virtualenv venv
  • activate venv --> source -r venv/bin/activate
  • install requirements --> pip install -r requirements.txt
  • cd into project directory --> cd anwesha
  • create a .env file in anwesha folder
  • add the an .env file in anwesha/anwesha to learn more about .env file and configuration read here.
  • run the server --> python manage.py runserver

Host using Docker ๐Ÿณ

  • use docker build command to build the image ( โ— please note that you should run this command in ๐Ÿ“ root directory where docker file is present ) )
docker build --tag <image_name>:latest .
  • run the image either from docker dashboard or using cli
docker run --name <image_name> -d -p 8000:8000 <imagge_name>:latest

File structure ๐Ÿ—„๏ธ

  • anwesha :- This is the source code for all the apis and configurations required for backend.
  • Dockerfile :- file containing instructions to build Docker Images.
  • docker-compose.yml :- configuration file for running multiple containers at once, it will be useful in hosting multiple docker containers with backend on server.
  • requirements.txt :- it contains all the pacakges required by the project. โ—Whenever a new library is added in the project please update the requirement.txt file.

backend-1's People

Contributors

rupakbiswas-2304 avatar melencholicmice avatar tejax-v2 avatar raunak-dev-edu avatar humanchwan avatar komachian 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.