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

Updated the README #1

Merged
merged 1 commit into from
Aug 16, 2024
Merged
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
27 changes: 15 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@

# **AOSSIE's Website**

This repository contains the assets required to build the **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**

Expand All @@ -18,34 +17,38 @@ Forking only needs to be done once, after which you can push changes to your for

# **Running the website Locally**

In order to run the site 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.
- 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:

```
npm install
npm run dev
```
- Install the required dependencies by running the following command:

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

- Start the development server with the following command:

```
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:

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


# **License**

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