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 #232 : Made the Readme.md file more interactive and easy to understand #304

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
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
66 changes: 35 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,55 @@
# **AOSSIE's Website**

# **AOSSIE's Website**
Welcome to the repository for **AOSSIE's Website**! We're thrilled that you're interested in contributing.

This repository contains the assets required to build the **AOSSIE's website**. We're glad that you want to contribute!
Your contributions are highly appreciated, whether you have ideas for new content or wish to address any issues with the existing content.

Contributions to the project are very much welcomed! Please reach out with ideas for new content or issues with existing content!
This website is a **Next.js** project that leverages **Tailwind** for styling and design.

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

# **Getting Started**
# **Getting Started**

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**
To contribute to this repository, follow these steps:
- **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**.

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 whenever needed.

# **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:
# **Running the Website Locally**

```
npm install
npm run dev
```

The website will be active at **http://localhost:3000**.
To run the website locally:
1. Fork the repository and clone the fork to your local system.
2. Open a terminal/command prompt and navigate to the directory of the cloned fork.
3. Run the following commands in the root directory:

```
npm install
npm run dev
```

# **Contributing**
The website will be accessible at **http://localhost:3000**.

You can contribute by:
---

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

There are many ways to contribute to this project:
- **Raise issues**: Report any bugs or suggest improvements.
- **Fix issues**: Submit pull requests to address any open issues.
- **Enhance the website**: Propose and implement new features or designs.
- **Spread the word**: Share about **AOSSIE** in your network.

If you want to get in touch with us first before contributing, you can use:
If you'd like to get in touch with us before contributing, feel free to reach out via:
- **[AOSSIE Discord Channel](https://discord.com/invite/6mFZ2S846n)**

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

# **License**

# **License**
This project is licensed under the **[MIT License](https://choosealicense.com/licenses/mit/)**.

[**MIT License**](https://choosealicense.com/licenses/mit/)
---
9 changes: 8 additions & 1 deletion src/pages/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,13 @@ export default function Home() {
<Container.Inner>
<div className="grid grid-cols-1 gap-x-12 gap-y-16 sm:grid-cols-2 lg:grid-cols-3">
{randomProjects.map((project) => (
<span key={project.name}>
<span
key={project.name}
style={{
userSelect: "none",
cursor: "pointer",
}}
>
<CardEffect
heading={project.name}
logo={project.logo}
Expand All @@ -157,6 +163,7 @@ export default function Home() {
</div>
</Container.Inner>
</div>

<div className="mt-12 text-center">
<Link
className="group relative inline-flex items-center overflow-hidden rounded-lg bg-[#00843D] px-8 py-3 text-white focus:outline-none active:bg-[#00843D] dark:bg-yellow-400 dark:text-zinc-900"
Expand Down