Africommerce (Repo: `Africommerce`)

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

<ul dir="auto">
  <li>
    First, you need to fork the <code>Africommerce</code> repository by clicking the <code>Fork</code> button on the top right corner of the repository.
  </li>
  <li>
    Next, you clone the forked repository by clicking the <code>code</code> button and then selecting the clone option.
  </li>
</ul>

<p>
  ⚠️ Please change the directory after cloning the repository using the <code>cd &lt;folder-name&gt;</code> command. In our case, the command to be ran is <code>cd africommerce-saas</code> </li> 
  
  <li>
    <h3 dir="auto">
      <a rel="nofollow noopener" target="_blank" id="user-content-track-the-original-repository-as-a-remote-of-the-forked-repository" class="anchor" aria-hidden="true" href="#track-the-original-repository-as-a-remote-of-the-forked-repository"></a>Track the original repository as a remote of the forked Repository
    </h3>
    
    <ul dir="auto">
      <li>
        To track the original repository as a remote of the forked Repository run this command;
      </li>
    </ul>
    
    <pre class="notranslate"><code> git remote add upstream git@github.com:africommerce/africommerce-saas.git

git fetch upstream

    <p>
      ⚠️ Please skip this step, if you are setting this project for your personal use. </li> 
      
      <li>
        <h3 dir="auto">
          <a rel="nofollow noopener" target="_blank" id="user-content-️-install-dependencies" class="anchor" aria-hidden="true" href="#%EF%B8%8F-install-dependencies"></a>⬇️ Install Dependencies
        </h3>
        
        <p>
          Next, install the dependencies by running the following command in the folder containing the <code>Africommerce</code> repository:
        </p>
        
        <pre>npm install </pre>
        
        <p>
          Or
        </p>
        
        <pre>yarn install </pre>
        
        <blockquote>
          <p>
            Note: <code>Africommerce</code> 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.
          </p>
        </blockquote>
        
        <pre>npm install --legacy-peer-deps</pre>
      </li>
      
      <li>
        <h3 dir="auto">
          <a rel="nofollow noopener" target="_blank" id="user-content--start-the-development-mode" class="anchor" aria-hidden="true" href="#-start-the-development-mode"></a>🦄 Start the Development Mode
        </h3>
        
        <p>
          Use the following command to start the app in the development mode:
        </p>
        
        <pre>npm start</pre>
        
        <p>
          Or
        </p>
        
        <pre>yarn start</pre>
        
        <p>
          It runs the app in development mode. Open <a rel="nofollow noopener" target="_blank" href="http://localhost:3000">http://localhost:3000</a> to view it in your browser.<br /> The page will reload when you make changes. You may also see any lint errors in the console. </li> 
          
          <li>
            <h3 dir="auto">
              <a rel="nofollow noopener" target="_blank" id="user-content--build-the-app-for-production" class="anchor" aria-hidden="true" href="#-build-the-app-for-production"></a>🧱 Build the App for Production
            </h3>
            
            <p>
              Use the following command to build the app for production:
            </p>
            
            <pre>npm run build</pre>
            
            <p>
              Or
            </p>
            
            <pre>yarn build</pre>
            
            <p>
              This command builds the app for production to the <code>build</code> 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. </li> 
              
              <li>
                <h3 dir="auto">
                  <a rel="nofollow noopener" target="_blank" id="user-content--deploy" class="anchor" aria-hidden="true" href="#-deploy"></a>🚀 Deploy
                </h3>
                
                <p>
                  You can deploy the app to <code>Vercel</code> or <code>Netlify</code> with a single click.
                </p>
              </li></ul> 
              
              <h2 dir="auto">
                <a rel="nofollow noopener" target="_blank" id="user-content--contributing-to-africommerce" class="anchor" aria-hidden="true" href="#-contributing-to-africommerce"></a>🤝 Contributing to <code>Africommerce</code><br />
              </h2>
              
              <p>
                Please help us to grow by contributing to the project. If you wish to contribute, you can;
              </p>
              
              <ul dir="auto">
                <li>
                  Suggest a Feature
                </li>
                <li>
                  Test the app and help in optimizing it.
                </li>
                <li>
                  Improve the app, fix bugs, etc.
                </li>
                <li>
                  Improve documentation.
                </li>
                <li>
                  Create content about Africommerce and share it with the world.
                </li>
              </ul>
              
              <p>
                Any kind of positive contribution is highly appreciated!
              </p>
              
              <blockquote>
                <p>
                  Please read <code>CONTRIBUTING</code> for details on our <code>CODE OF CONDUCT</code>, and the process for submitting pull requests to us.
                </p>
              </blockquote>
              
              <h2 dir="auto">
                <a rel="nofollow noopener" target="_blank" id="user-content--support" class="anchor" aria-hidden="true" href="#-support"></a>🙏 Support
              </h2>
              
              <p>
                Please support the work by:
              </p>
              
              <ul dir="auto">
                <li>
                  Giving the repository a ⭐
                </li>
                <li>
                  Contributing to it
                </li>
                <li>
                  <a rel="nofollow noopener" target="_blank" href="https://../CONTRIBUTING.md/">Sponsoring the project</a>.
                </li>
                <li>
                  Follow us on Twitter <a rel="nofollow noopener" target="_blank" href="https://twitter.com/">@Africacommerce</a>.
                </li>
              </ul>
              
              <p>
                If you found the software helpful, consider supporting by buying us coffee ☕<br /> <a rel="nofollow noopener" target="_blank" href="https://www.buymeacoffee.com/"></p> 
                
                <p>
                  </a>
                </p>
                
                <h2 dir="auto">
                  <a rel="nofollow noopener" target="_blank" id="user-content-launching-africommerce-rewards" class="anchor" aria-hidden="true" href="#launching-africommerce-rewards"></a>Launching <code>Africommerce</code> Rewards
                </h2>
                
                <p>
                  Contributed to Africommerce? Here is a big <strong>Thank you</strong> from our community to you.<br /> Claim your badge and showcase them with pride on any of your social media profile.<br /> Let us inspire more folks!<br /> <a rel="nofollow noopener" target="_blank" href="https://aviyel.com/assets/uploads/rewards/share/project/43/512share.png">Africommerce Badges</a>
                </p>
                
                <h3 dir="auto">
                  <a rel="nofollow noopener" target="_blank" id="user-content-claim-now" class="anchor" aria-hidden="true" href="#claim-now"></a><strong><a rel="nofollow noopener" target="_blank" href="https://aviyel.com/projects/43/africommerce/rewards">Claim Now!</a></strong><br />
                </h3>
                
                <h2 dir="auto">
                  <a rel="nofollow noopener" target="_blank" id="user-content-contributors-" class="anchor" aria-hidden="true" href="#contributors-"></a>Contributors ✨<br />
                </h2>
                
                <p>
                  Thanks goes to these wonderful people (<a rel="nofollow noopener" target="_blank" href="https://allcontributors.org/docs/en/emoji-key">emoji key</a>):
                </p>
                
                <p>
                  This project follows the all-contributors specification. Contributions of any kind are welcome!
                </p>
                
                <p>
                </p>

Africommerce (Repo: Africommerce)