Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated readme.md and contributers.md #10

Merged
merged 7 commits into from
Oct 22, 2023
Merged

updated readme.md and contributers.md #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a337555
Update CONTRIBUTING.md
priyanshu9899 Oct 21, 2023
23ce4af
Update README.md
priyanshu9899 Oct 21, 2023
f2cc0b9
Update README.md
priyanshu9899 Oct 21, 2023
ed3cf81
Update CONTRIBUTING.md
priyanshu9899 Oct 21, 2023
46b532e
Update README.md
priyanshu9899 Oct 21, 2023
d023b32
Update README.md
priyanshu9899 Oct 21, 2023
3cb3dac
Update README.md
paardarshee Oct 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Edit this
with

npm i
npm start

as someone can copy paste the codes directly

Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ Follow the steps below to get started with contributing to [GDSC AEC Official We

- Replace `your-username` with your GitHub username.

### 4. RUN the following command on your terminal

npm i
npm start

### 3. Explore the Codebase
- Take some time to explore the project's codebase. You can do this by navigating through the files and directories in the cloned repository.

Expand Down
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Here in line 19,
    Update it, as it is no longer just an HTML, CSS, and JS Website.
    Now It is using React with Vite and Tailwind

  • In line 28,29 Add those scripts you added in Contributing.md
    after git clone ...., Add this scripts:-

    cd GDSCAEC-WEBSITE
npm i
npm start

  • After the git commit msg (line 32) add Sync your local clone in our repositories section on github and Add this script git pull origin your_branch_name to resolve your merge conflict locally

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure

Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,16 @@
<img src="https://api.netlify.com/api/v1/badges/c432dfd8-3238-4782-baac-40d80621cfe8/deploy-status" />
</p>

<h6 align="center"><img src="./assets/GDSC%20AEC%20BANNER.jpg" /></p></h6>
<h6 align="center"><img src="https://raw.githubusercontent.com/gdsc-aec-india/branding/main/assets/GDSC-AEC-Community-Banner.png" /></h6>
<p align="center"><img src="https://raw.githubusercontent.com/gdsc-aec-india/branding/main/assets/GDSC-AEC-Logo.png" height="100px"/></p>
<h1 align="center"><code>&nbsp;GDSC AEC Community Website&nbsp;</code></h1>

<a href="https://gdsc.community.dev/asansol-engineering-college-asansol/"> GDSC AEC </a> is the official Google Developer Student Club (GDSC) of Asansol Engineering College (AEC). It is a community group for students who are passionate about technology, software development and innovation. We also host events such as codesprints, tech talks, and workshops that aim to foster creativity, problem-solving skills, and a deeper understanding of Google technologies. One of our main aims is to be inclusive and open to students of all experience levels, including those who are new to technology and programming. Joining our fraternity might help you with networking opportunities, skill development, and the chance to work on projects that can make a real impact.

This repository has been created as an effort to encourage open source contributions as well as to help people get acquainted with Hacktoberfest.

This is the student-run community site of GDSC AEC Chapter using HTML, CSS and JavaScript. For any queries join our [Discord](https://discord.gg/r5C2yRwqva) community chats and feel free to [connect with us](https://gdscaec.bio.link).
This is the student-run community site of GDSC AEC Chapter ,it is no longer just an HTML, CSS, and JS Website.Now It is using React with Vite and Tailwind.
For any queries join our [Discord](https://discord.gg/r5C2yRwqva) community chats and feel free to [connect with us](https://gdscaec.bio.link).

<br>

Expand All @@ -26,9 +28,14 @@ This repository has been created as an effort to encourage open source contribut
- Assign yourself an [issue](https://github.com/GDSC-AEC-INDIA/GDSCAEC-WEBSITE/issues) and fork this repo. For more information read [CONTRIBUTING](./CONTRIBUTING.md)
- Clone repo locally using `git clone https://github.com/gdsc-aec-india/GDSCAEC-WEBSITE`
- After cloning make sure you create a new branch by using `git checkout -b my-branch`
- Now , run this following commands in your terminal.
- cd GDSCAEC-WEBSITE
npm i
npm start
- Start making edits in the newly created git branch. Firstly, add your name in the [`CONTRIBUTORS`](./CONTRIBUTORS) file
- Add the modified/created files to the staging using `git add .`
- Commit the changes made into the checked out branch using `git commit -m "commit message"`
- Sync your local clone in our repositories section on github and add this script `git pull origin your_branch_name` to resolve your merge conflict locally
- Push the changes using `git push origin my-branch`

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
Expand Down