Skip to content

Commit cae2ca1

Browse files
authored
Merge pull request #375 from Shreya111111/shreya
update: add docs to setup in local environment
2 parents eab56a4 + 9dc1676 commit cae2ca1

File tree

1 file changed

+79
-0
lines changed

1 file changed

+79
-0
lines changed

README.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,85 @@ DevsInTech offers a wide range of resources and opportunities for developers and
4848

4949
[![Next.js](https://img.shields.io/badge/next.js-%2320232a.svg?style=for-the-badge&logo=next.js&logoColor=%2361DAFB)](https://nextjs.org/) [![TailwindCSS](https://img.shields.io/badge/Tailwind_CSS-%23326ce9.svg?style=for-the-badge&logo=tailwindcss&logoColor=white)](https://tailwindcss.com/)
5050

51+
## Getting Started 👩‍💻
52+
53+
> ⚠️Prerequisites
54+
>
55+
> - Before getting into it, make sure you have [pnpm](https://nodejs.org/download) installed.
56+
57+
58+
### Let's jump right in🌟
59+
60+
1. Fork the project
61+
2. Clone the project to run on your local machine using the following command:
62+
63+
```sh
64+
git clone https://github.com/<your_github_username>/DevsInTech.git
65+
```
66+
67+
3. Get into the root directory
68+
69+
```sh
70+
cd DevsInTech
71+
```
72+
73+
4. Install all dependencies by running
74+
75+
```sh
76+
pnpm install
77+
```
78+
79+
5. Create your branch
80+
81+
```sh
82+
git checkout -b <your_branch_name>
83+
```
84+
85+
6. Run and view the application on localhost
86+
87+
```sh
88+
pnpm run dev
89+
```
90+
91+
7. Make your changes
92+
93+
8. Stage your changes
94+
95+
```sh
96+
git add <filename>
97+
```
98+
99+
9. Commit your changes
100+
101+
```sh
102+
git commit -m "<your-commit-message>"
103+
```
104+
105+
10. Push your changes to your branch
106+
107+
```sh
108+
git push origin "<your_branch_name>"
109+
```
110+
111+
11. Create a Pull Request.
112+
113+
> Click _compare across forks_ if you don't see your branch
114+
115+
### Setup using Docker
116+
117+
* Enter the root directory
118+
119+
```sh
120+
docker build .
121+
122+
```
123+
124+
125+
```sh
126+
docker run -p 3000:80 <Image>
127+
```
128+
129+
51130
# Contribute
52131
53132
We welcome contributions in our community. Learn how to start contributing, from installing the project on your device to submitting a pull request with our<Link href="https://github.com/devs-in-tech/DevsInTech/blob/main/CONTRIBUTING.md"> Contribution guide.<Link/>

0 commit comments

Comments
 (0)