Skip to content

This TypeScript backend repository enables users to create and manage events on a website. Users can register and participate in events, with optional payment integration through Stripe for events with associated costs.

Notifications You must be signed in to change notification settings

kiranadh1452/event-registrator-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Events Registrator Backend

This repo holds the backend code for events registration.

Note There are two folders here, js and ts. The js folder holds the javascript version of the backend and the ts folder holds the typescript version of the backend. The ts folder is still under development. So, it is recommended to use the js folder.

How to run the js version?

This method of running the app is not recommended. It is recommended to run the app through docker.

  1. Clone this repo and cd into the js folder.
         git clone git@github.com:kiranadh1452/event-registrator-backend.git
         cd event-registrator-backend/js
  2. Install the dependencies.
        npm install
  3. Open the file src/config/config.example and fill in the required fields.
  4. Rename the file to config.env.
  5. Run the following command:
        npm start

How to Run through Docker ?

Easy as pie. Just make sure that you have docker and docker-compose installed on your machine.

  • Clone this repo.

         git clone git@github.com:kiranadh1452/event-registrator-backend.git
  • Open the file src/config/config.example and fill in the required fields.

  • Rename the file to config.env.

  • Then run the following command:

        docker build -t ev-reg-back .
        docker-compose up

    While running the command, make sure that the active directory is the same as the docker-compose.yml file.

If you're on linux :

This method is not recommended. I only created this script to make my life easier. This script was originally made to automate the tasks of docker image creation and publishment to docker hub. It is recommended to run the app through docker.

Open the file src/config/config.example and complete the instructions in the file.

Then run the following commands:

    sudo chmod +x run-backend.sh
    sudo ./run-backend.sh

About

This TypeScript backend repository enables users to create and manage events on a website. Users can register and participate in events, with optional payment integration through Stripe for events with associated costs.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published