Skip to content

Commit

Permalink
Updated the README
Browse files Browse the repository at this point in the history
  • Loading branch information
fakegithub01 committed Aug 16, 2024
1 parent 014bfe3 commit f4dcdea
Showing 1 changed file with 15 additions and 12 deletions.
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/)

0 comments on commit f4dcdea

Please sign in to comment.