Skip to content

open-nest-africa/website

Repository files navigation

🌸 OpenNest-Africa Website

Welcome to OpenNest-Africa Website, a cozy hub where beginners—technical or non-technical—can explore, learn, and grow in the world of open source.


📖 Table of Contents


🌟 What is OpenNest-Africa?

OpenNest-Africa is a beginner-friendly, community-driven space designed to:

  • Provide resources to help you make your first contribution to OpenSource.
  • Support all roles—from coding to documentation, design, and more.
  • Guide you step-by-step through your open-source journey.
  • Foster inclusivity, welcoming contributors of all backgrounds and skill levels.

🌱 How to Contribute to OpenNest-Africa Website

Every contribution counts at OpenNest, no matter how little:

  • Explore our Designers, Developers, and Technical Writers guides to kickstart your contributions!
  • Find a Beginner Task – Look for issues tagged good first issue.
  • Create an issue or pull request to suggest improvements.
  • Help others by answering questions or joining discussions.
  • Share resources you’ve found useful.
  • Ask for Help – We're here to support you!

📚 Features & Pages

Here are the currently available and functional pages in the application:

  • Home Page (/) The OpenNest home page provides an overview of the project and guidance on how to get started as an open-source enthusiast. Home page

    • Resources (/resources) The resources page contains materials that can help you get started, regardless of your field. We have included videos that explain extensively how you can contribute to an open-source project. You can use the arrow icon to navigate to the resource of your choice.

    Resources page

    • About Us (/about-us) This page provides information about the four unique individuals who are the brains behind OpenNest. It also calls on open-source enthusiasts to contribute to the project to make the open-source journey easier for others.

    About us page

  • Dashboard (/dashboard) The dashboard gives you exclusive access to the OpenNest community, while also helping you keep track of the projects you've contributed to and providing a list of projects you can contribute to. To access this page, You can either login with your github or google account.

    Dashboard

  • OpenAI Page (/dashboard/openai) The Openai page is only accessible once you login to the dashboard. The plan is to integrate OpenAI, making it easy for you to use the AI prompts while on the platform.

    Openai page


⚠️ Limitations

There's still so much to do on the project, as most of the data are just dummy data. This is why we are making it open to everyone around the world to contribute. Please note the following limitations in the current version of the project:

  • Sign Up and Sign In with Google: Not implemented yet.
  • Responsiveness: The app is not fully responsive on mobile devices yet.
  • The dashboard is also a work in progress. We’re actively working on resolving these issues. Contributions are welcome!

🌟 Future Improvements

  • Have enough resources
  • Onboard 1000 active contributor before the end of 2025
  • Create Mentorship Programs for beginners in open source
  • Have our first OpenNest Africa Summit

🌱 How to Fork and Run the Project Locally

Follow these simple steps to get the OpenNest Africa website running on your local machine. Don’t worry if you’re new to this, we’ve got your back every step of the way! 🚀

🧰 Requirements Before we start, make sure you have these installed on your computer:

  • Node.js version 20.12.0 or higher — Download Node.js

  • npm version 10.5.0 or higher (npm comes bundled with Node.js)

1. Fork the Repository

This will create your own copy of the project on your GitHub account.

Go to the top-right corner of this page and click the Fork button.

This will copy the repository to your GitHub account under your ususername.

2. Clone Your Fork Locally

Now, let’s get that forked repository on your own computer.

Open your terminal (Command Prompt, Git Bash, or any terminal you prefer).

Run the following commands:

git clone https://github.com/YOUR-USERNAME/website.git cd website

Replace YOUR-USERNAME with your actual GitHub username. This downloads the code to your machine and moves into the project folder.

3. Install Project Dependencies

The project uses some tools and libraries that need to be installed before running.

  • Run this command in your terminal inside the project folder: npm install

This will download and install everything the project needs to work.

4. Run the Development Server

Let’s start the project so you can see it live on your browser.

  • Run this command to launch the local server: npm run dev

  • Once it’s running, open your browser and go to: http://localhost:5173

You should see the OpenNest Africa website running locally! 🎉

Need Help?

  • If you get stuck, don’t hesitate to ask on our Slack community, we’re here to help you get started smoothly!

💌 Our Values

We believe in collaboration, kindness, and learning. At OpenNest, everyone is welcome, whether you're a first-timer or an experienced contributor. - Review our Code of Conduct to help us maintain a respectful and inclusive space.


📬 Get in Touch

If you have questions or ideas or want to say hello, we'd love to hear from you!


About

🌸 OpenNest Website – Your safe, inclusive hub for open-source beginners!

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

  •  

Packages

No packages published

Contributors 17