An awesome README template to jumpstart your projects!
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
AuthentiCart, an Apollo-level project, is an e-commerce platform primarily motivated by the issue of rising product authenticity issues present in today's e-commerce platforms.
AuthentiCart has a main core feature - promising buyers authenticity of goods sold on the platform. We will implement this through introducing a new user of the platform - middleman. Middleman has the role of vetting all new sellers' goods and ensuring that the goods sold are as described. This vetting will be done through our warehouse. After enough successful transactions, sellers will be considered 'experienced' and will be able to bypass this vetting system. However, buyers are still able to report a transaction if a good is deemed to be faulty, or not as described.
To get a local copy up and running follow these simple example steps.
- npm
npm install npm@latest -g npm i npm run dev
Open http://localhost:3000 with your browser to see the result.
Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.
- Get a free API Key at https://example.com
- Clone the repo
git clone https://github.com/your_username_/Project-Name.git
- Install NPM packages
npm install
- Enter your API in
config.jsconst API_KEY = 'ENTER YOUR API';
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
For more examples, please refer to the Documentation
- Add Changelog
- Update README.md
- Add report feature
- Multi-language Support
- Chinese
- Spanish
See the open issues for a full list of proposed features (and known issues).
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Marc HongJun Lim - [email protected] Tan Wei Lian - [email protected]
Project Link: https://github.com/2guys1repo/orbital-shop.git
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!