richgod93 / adun-social-open-source

A social network for the students of Admiralty University of Nigeria.

ADUN Social

A social network for the students of Admiralty University of Nigeria.

Goals 📍

• This project is open source because I want to give room for growing developers in Admiralty University of Nigeria to contribute to the growth of this project and tailor it to their liking as well.
• The aim of this project is to enable students on campus to connect and interact with eachother online by sharing posts, reacting to the posts of peers by liking or commenting.

I'm still working on this README so there will be more information here about this project with time.

Basic Website Structure 🏗

• Landing page
• Authentcation pages (Login/Sign up)
• News Feed
• Chats (Coming soon)
• Profile page

Contributing to ADUN SOCIAL 🛠

Thank you for considering contributing to ADUN SOCIAL! We welcome contributions from developers like you to make our project better.

Please take a moment to review this document for important information about the contribution process.

Table of Contents

• Code of Conduct
• Getting Started
  • Forking the Repository
  • Cloning Your Fork
  • Setting Up the Development Environment
• Making Changes
  • Branching
  • Committing Changes
• Creating a Pull Request
  • Title and Description
• Review and Merge
• Code of Conduct
• License

Code of Conduct

We want to ensure a positive and respectful environment for all contributors. Please read and adhere to our Code of Conduct.

Getting Started 🎬

Forking the Repository

Click on the "Fork" button at the top right corner of the repository to create your copy of the project.

Cloning Your Fork

Clone your forked repository to your local machine. Replace <your-username> with your GitHub username:

git clone https://github.com/<your-username>/ADUN-SOCIAL-OPEN-SOURCE.git

Setting Up the Development Environment

After cloning your forked repository, do the following:

• Install dependencies required for the project.
• Follow the setup instructions in README.md to configure your environment.
• Run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 with your browser to see the result.

Making Changes

Branching

Create a new branch for the feature or bug fix you're working on:

git checkout -b feature/my-feature

Committing Changes

Make your code changes and commit them with clear, concise messages:

git commit -m "Add new feature: My Feature"

Creating a Pull Request

When your changes are ready for review, create a pull request:

1. Go to the original repository on GitHub.
2. Click on "Pull Requests."
3. Click the "New Pull Request" button.
4. Select your fork and the branch with your changes.

Title and Description

• Give your pull request a descriptive title.
• Provide a detailed description of the changes made, including the purpose and any related issues.

Review and Merge

Your pull request will be reviewed by the maintainers. Make any requested changes if necessary. Once approved, your changes will be merged into the main branch.

Congratulations! You've successfully contributed to ADUN SOCIAL.

Code of Conduct

Please follow our Code of Conduct to ensure a welcoming and inclusive community.

License

By contributing to this project, you agree that your contributions will be licensed under the LICENSE of this project.

---

Thank you for your interest in improving ADUN SOCIAL. We appreciate your contributions and look forward to collaborating with you!

adun-social-open-source's Issues

Request for Responsive Design - Ensuring Compatibility Across Mobile Screens

Issue Description:
We are currently facing challenges with the responsiveness of our website, ADUN SOCIAL. In an era where mobile devices come in various sizes and resolutions, it's crucial that our website adapts seamlessly to all screens, providing an optimal user experience.

Scope:
This issue is a request to enhance the website's responsiveness, ensuring it functions flawlessly on a wide range of mobile screens. The goal is to eliminate issues like layout distortions, misalignment, or content overflow on smaller or differently sized screens.

Expected Outcome:

1. All website elements (e.g., text, images, buttons) should be appropriately scaled and displayed on mobile devices, regardless of screen size or orientation.
2. User interface components should adapt to smaller screens, maintaining readability and usability.
3. Testing on various mobile devices and browsers to ensure consistent performance.

Why It Matters:

• Improved User Experience: A responsive design guarantees that users can access and interact with our website comfortably on their mobile devices.
• Wider Audience: Mobile traffic constitutes a significant portion of web users. A responsive site ensures we reach and engage with a broader audience.
• SEO Benefits: Search engines prioritize mobile-friendly websites, leading to improved search rankings.

Contributing to this Issue:
We invite contributions from the community to address this critical enhancement. Whether you are a developer, designer, or tester, your expertise is valuable in achieving a responsive design. Please comment on this issue if you intend to work on it or if you have insights to share.

Additional Context:

• Our current tech stack: Next.js, TailwindCSS, Firebase.
• Relevant files: All files are relevant, look through the files, implement responsive design where deemed necessary.

Let's work together to make ADUN-SOCIAL accessible and enjoyable on mobile devices. Your contributions will play a pivotal role in enhancing our user experience. If you have any questions or ideas related to this issue, please feel free to share them here.

Thank you for your commitment to improving ADUN-SOCIAL-OPEN-SOURCE! 🚀