README.md

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact
6. Acknowledgments

About The Project

AkhtarsList is a highly responsive online auction platform that allows users to sell and bid on items in a swift, secure, and convenient environment.

(back to top)

Built With

• 
• 
• 
• 
• 

(back to top)

Getting Started

To begin, clone this repo onto your local machine and follow the steps accordingly.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• cd Open two terminals and change directories into the following directories

      cd ../AkhtarsList/client

      cd ../AkhtarsList/server

• npm Install the requires packages in both directories

      npm i

Installation

This project relies on external services such as MongoDB, JWT, Cloudinary.

1. Clone the repo

   git clone https://github.com/kankenny/AkhtarsList.git

2. Create two .env files in the client and server directory. Env file examples are placed within the client and server directories for reference.

   • In the client .env, fill in the values of following variables:

    VITE_BACKEND_SERVER_PORT={PORT_NUMBER}
    VITE_CLOUDINARY_URL={CLOUDINARY_API_URL}

   • In the server .env, fill in the values of the following variables

    PORT={PORT_NUMBER}
    MONGODB_URL={MONGODB_API_KEY}
    JWT_KEY={JWT_KEY}

(back to top)

Backlogs

High Priority

1.) Validation Libraries and ReactHookForm (Zod & RHF) [currently being implemented by KJB]
2.) Communication Feature

Low Priority

1.) Fix bug where the profile route doesn't initially render the admin link. I.e. it requires a refresh to show the admin link when the authenticated user is an admin

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

• Danny Chen - [email protected]
• Kennette James Basco - [email protected]

(back to top)

Acknowledgments

• Best-README-Template

(back to top)