Grosik

The app helps the user picks the best offer from several supermarkets.
Explore the docs »

Report Bug · Request Feature

Table of Contents

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

About The Project

We are three colleagues from CodersLab's bootcamp who make some difference and set up our project. We try to use the best and already known in our practices. If you have some questions don't hesitate to ask us! We are open to all suggestions! We are self-organization because we know we need experience for our future job as developers. During the project, we try to work in agile. Our "helpers" in this are and .

This is an application where everyone can create their shopping list and compare it with prices in different stores. Thanks to this, the user can find the best offers for himself.

Check out our project!

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

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

• npm

  npm install npm@latest -g

Installation

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/propanibutan/grosik-app

3. Install NPM packages

   npm install

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

(back to top)

Usage

(back to top)

Roadmap

• Basic configuration
• Database
• Landing page (in progress)
• API (in progress)
• Authentication
  • Login
  • Registration
  • Logout
• Application page
  • A buy list with login
  • A buy list without login
  • Matching of databases

See the open issues for a full list of proposed features (and known issues).

(back to top)

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

• Paweł Pitura - Linkedin - [email protected]
• Karolina Starowicz - Linkedin - [email protected]
• Patrycja Zalas - Linkedin - [email protected]

Project Link: https://github.com/propanibutan/grosik-app

(back to top)