Skip to content

Latest commit

 

History

History
231 lines (166 loc) · 8.54 KB

README.md

File metadata and controls

231 lines (166 loc) · 8.54 KB
Raw

Contributors Forks Stargazers Issues MIT License


Logo

Goldies

Uma e-commerce de discos de vinis
Explore the docs »

· Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License

About The Project

Product Name Screen Shot

This project is beyond a record store because it consists of an e-commerce of vinyl records that are currently few. Bringing discs of other variations for all musical genres.

Here's why:

  • Project aimed at the technical course where a work involving knowledge learned at school is proposed. But most stacks we don't learn in the course.
  • The intention is to be simple and intuitive for most people to understand in a simple way. It uses technologies that focus on agility and comfort for the user.
  • This project involves principles such as detailed documentation, prototyping, mockups being our "marketing", and programming of course. 😄

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue.

(back to top)

Built With

Front-end stacks

  • JavaScript
  • React
  • SASS
  • TailwindCSS
  • Redux

Back-end stacks

  • TypeScript
  • NodeJS
  • Express.js
  • PHP
  • Insomnia
  • JWT

Testing

  • Jest
  • Testing-Library

Databases

  • MariaDB

Design and Merch

  • Canva
  • Figma

Organization

  • Notion

IDE

  • GITPOD
  • VsCode

(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

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.

  1. Get a free API Key at https://example.com
  2. Clone the repo 
    git clone https://github.com/CarlosEduardoAD/sa-senai-vinil.git
  3. Install NPM packages for Front-end and Back-end 
    npm install
  4. Compiles and hot-reloads for development on Front-end 
    npm run start
  5. Compiles and minifies for production on Front-end
npm run build
  1. Start server on Back-end
npm run serve

(back to top)

Usage

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

(back to top)

Roadmap

  • JsonWebToken
  • Unit Testing
  • Cart
  • API Wishlist
  • Multi-language Support
    • Portuguese
    • English

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)