Skip to content

GabrielGuedess/CodeLeap

Repository files navigation

Codecov Vercel CI Netlify Status Top wakatime


Logo

CodeLeap Network

View Demo · Report Bug · Request Feature

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

About The Project

image

The goal is to create a very simple application that will perform basic CRUD functions.

(back to top)

Built With

Frameworks/libraries used to initialize the project.

  • Next JS
  • React
  • TypeScript
  • Styled Components
  • React Hook Form
  • Storybook
  • Jest
  • Testing-Library
  • ESLint

(back to top)

Storybook

Storybook is a frontend workshop for building UI components and pages in isolation. Thousands of teams use it for UI development, testing, and documentation.


yarn storybook
yarn build-storybook

(back to top)

Lighthouse


See details

(back to top)

Codecov

Codecov provides metrics and insights into the results of tests through code coverage reports. Coverage reports are used to determine which lines of code were tested and which lines were not tested, which may contain bugs and syntax errors.


(back to top)

Getting Started

Prerequisites

NodeJs

Installation

  1. Clone the repository.

    git clone https://github.com/GabrielGuedess/CodeLeap
  2. Install the dependencies.

    # With npm
    npm i
    
    # With yarn
    yarn
  3. Start project.

    # With npm
    npm run dev
    
    # With yarn
    yarn dev

(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".

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

(back to top)

License

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

(back to top)

Deploying

Deploy with Vercel

Contact

Gabriel Guedes - @GabrielRGuedess - [email protected]

Project Link: https://code-leap-gabrielguedess.vercel.app/


Made with ♥ by 👨‍🚀 Gabriel Guedes 👋 Get in touch!

(back to top)