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.

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

Fix Inconsistent Capitalization in README.md #233

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
36 changes: 16 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,47 @@

# **AOSSIE's Website**

This repository contains the assets required to build the **AOSSIE's website**. We're glad that you want to contribute!
This repository contains the assets required to build **AOSSIE's website**. We're glad that you want to contribute!

Contributions to the project are very much welcomed! Please reach out with ideas for new content or issues with existing content!

Th website is a **Next.js** project using **Tailwind** for styling and design.
The website is a **Next.js** project using **Tailwind** for styling and design.

# **Getting Started**

To contribute to this repository you will need to:
To contribute to this repository, you will need to:
- **Fork this repository**
- **Push changes to a new branch in your fork**
- **Create a pull request from that branch to the master branch of this repository**
- **Create a pull request from that branch to the `Master` branch of this repository**

Forking only needs to be done once, after which you can push changes to your fork.
You only need to fork the repository once. After that, you can push changes to your fork as needed.

# **Running the website Locally**
# **Running the Website Locally**

In order to run the site locally,
- Fork the website and clone that fork on your system
- Open a terminal/command prompt window and change the current directory to the directory of the cloned fork on your system.
- In the root directory, you can run the following commands:
To run the site locally:
1. Fork the website and clone that fork on your system.
2. Open a terminal/command prompt window and change the current directory to the directory of the cloned fork on your system.
3. In the root directory, run the following commands:

```
npm install
npm run dev
```
```bash
npm install
npm run dev
```

The website will be active at **http://localhost:3000**.


# **Contributing**

You can contribute by:

* Raising any issues you find
* Fixing issues by opening Pull Requests
* Improving website
* Improving the website
* Talking about AOSSIE


If you want to get in touch with us first before contributing, you can use:
If you want to get in touch with us before contributing, you can use:

* [AOSSIE Discord Channel](https://discord.com/invite/6mFZ2S846n)


# **License**

[**MIT License**](https://choosealicense.com/licenses/mit/)