https://github.com/open-source-chandigarh/project-template
Here's guide on how to structure your README.md file while submitting your project work
https://github.com/open-source-chandigarh/project-template
Last synced: 3 months ago
JSON representation
Here's guide on how to structure your README.md file while submitting your project work
- Host: GitHub
- URL: https://github.com/open-source-chandigarh/project-template
- Owner: Open-Source-Chandigarh
- Created: 2022-08-15T02:08:40.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-15T02:42:07.000Z (almost 3 years ago)
- Last Synced: 2025-01-16T00:18:48.066Z (5 months ago)
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Title: How to Build XYZ using Language[1,2,3] and Docker
- Add 4-5 lines introduction to your project
- Try to elaborate on the overall project work.
- [Optional] - Add video, if possible. This video covers on how to install this app and brief explanation of the project work.
## Technical Stack
- Frontend Language
- Backened Language
- Tools(like Docker, K8s)
- Database
## How it works?
- Add architecture diagram
- Show detailed information on how it works
## Prerequisite
- Add what pre-requisite software is required(for example, Install Docker Desktop)
## Step 1 - Clone the repository
```
git clone https://github.com//projectname
```
## Step 2 - Change directory to projectname
```
cd projectname
```
## Step 3 - Create docker image
```
docker build -t /projectname
```
## Step 4 - Run it on server
```
docker run -p 3000:3000 /projectname
```
## Step 5: Add Screenshot
- It's always good to showcase your overall project work in terms of screenshots
## Step 6. Add References
- Did you refer to any blog or tutorial or repository? If yes, then it's not a bad idea to capture it here.
## Sample Examples
- [Cryptotracker](https://github.com/Open-Source-Chandigarh/Cryptotracker)
- [The Pico Project](https://github.com/collabnix/pico)
- [How to Build the First containerized JAVA web application](https://github.com/dockersamples/genie-website-java)