/React-Africommerce

This is African ecommerce website by using React.

Primary LanguageJavaScriptMIT LicenseMIT

Africommerce (Repo: Africommerce)

Contributors Forks Stargazers Issues MIT License

Report Bug · Request Feature

Introduction

AfriCommerce is a Software As Service E-commerce platform that allows all signed up users in Africa to own their own customized store and connects buyers to prospective sellers for free.

🧰 Technologies Used

  • Backend Development

    • NodeJS
    • Express
    • MongoDB
  • Frontend Development

    • HTML
    • CSS
    • ReactJs

🏗️ How to Set up Africommerce for Development

You may want to set up the Africommerce repository for the following reasons:

  • You want to contribute to the Africommerce repo in general. To contribute to this project, please check the Contribution Guide to get started.
  • You want to use it as part of your own personal project.

Prerequisite

In order to setup this project, you need prior knowledge on how to;

  • Use an IDE of your choice (VSCode, Sublime, Atom, etc)
  • Basic knowledge on how to use Github (fork, clone, pull, push)

Here is a quick overview on how to setup the Africommerce repository as a contributor:

  • 🍴 Fork and Clone the Repository

    • First, you need to fork the Africommerce repository by clicking the Fork button on the top right corner of the repository.
    • Next, you clone the forked repository by clicking the code button and then selecting the clone option.

    ⚠️ Please change the directory after cloning the repository using the cd <folder-name> command. In our case, the command to be ran is cd africommerce-saas

  • Track the original repository as a remote of the forked Repository

    • To track the original repository as a remote of the forked Repository run this command;
     git remote add upstream git@github.com:africommerce/africommerce-saas.git
     git fetch upstream
    

    ⚠️ Please skip this step, if you are setting this project for your personal use.

  • ⬇️ Install Dependencies

    Next, install the dependencies by running the following command in the folder containing the Africommerce repository:

    npm install 

    Or

    yarn install 

    Note: Africommerce runs on React 18. However, some of our dependencies are yet to upgrade to version 18. So please use the following command when you face difficulties installing the dependencies.

    npm install --legacy-peer-deps
  • 🦄 Start the Development Mode

    Use the following command to start the app in the development mode:

    npm start

    Or

    yarn start

    It runs the app in development mode. Open http://localhost:3000 to view it in your browser.

    The page will reload when you make changes. You may also see any lint errors in the console.

  • 🧱 Build the App for Production

    Use the following command to build the app for production:

    npm run build

    Or

    yarn build

    This command builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.

  • 🚀 Deploy

    You can deploy the app to Vercel or Netlify with a single click.

🤝 Contributing to Africommerce

Please help us to grow by contributing to the project. If you wish to contribute, you can;

  • Suggest a Feature
  • Test the app and help in optimizing it.
  • Improve the app, fix bugs, etc.
  • Improve documentation.
  • Create content about Africommerce and share it with the world.

Any kind of positive contribution is highly appreciated!

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us.

🙏 Support

Please support the work by:

If you found the software helpful, consider supporting by buying us coffee ☕


Launching Africommerce Rewards

Contributed to Africommerce? Here is a big Thank you from our community to you. Claim your badge and showcase them with pride on any of your social media profile. Let us inspire more folks!

Africommerce Badges

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind are welcome!