Backend API application for MS Club of SLIIT 🌀
Read further to know how you can start contributing to MS Club!
- Fork the repo on GitHub
. - Clone the project to your own machine.
git clone https://github.com/<YOUR_USERNAME>/msclubwebsite.git
- Create a branch using the git checkout command. Branch name prefix should be one of these.
feature/<branch_name>
fix/<branch_name>
git checkout -b <your-new-branch-name>
- Stage your changes and commit with a meaningful commit message. First letter of the commit should be capital
git add .
git commit -m "<initial commit>"
- Push your work back up to your fork.
git push origin <add-your-branch-name>
- Submit a Pull request so that we can review your changes. Learn about creating a pull request.
We got your back. Here are some FREE resources for you to strengthen your web development skills and start firing some commits.
TypeScript
Node JS / Express
We use Docker 🐳 image to deploy this API application to the server. You can build and run the docker container in your local machine. Follow below steps to build and run the Docker container.
📝 In order to build and run the Docker container, you must have Docker install on you computer.
- Build the Docker image. 🏗️
docker build -t ghcr.io/ms-club-sliit/msclubwebserver:v1.0.0 .
- Check the build Docker images. ✔️
docker image ls
- Run the Docker container. After run this command the container will start running. 📦
docker run -p <expose_port>:<application_port> -d --name "<name_for_the_container>":<tag>
-d- Run in ditach mode
-p- Port mapping between Docker container and application
docker run -p 9096:8078 -d --name "mswebserver" ghcr.io/ms-club-sliit/msclubwebserver:v1.0.0
- Open your web browser and paste below URL 🌏
http://localhost:9096
- View the running container 👀
docker ps
- Stop the running container 🛑
docker stop mswebserver
- Remove the Docker container ⚰️
docker rm mswebserver