Giter VIP home page Giter VIP logo

react-template-ts's Introduction

react-template-ts

{{project name}} web app

Project architecture:

  • Framework: React

  • Language: Typescript

  • Web standard: HTML 5

  • Styling framework: SASS

  • Packet manager: Yarn

Project requirements:

Requirements for the project: {{here will go requirements}}

Shared design: {{here will go design for the project, if it exist}}

API swagger/documentation: {{documentation for the API, if it exist}}

Project implementation:

Application parts below are flagged like this:

  • ๐Ÿ“’ Folders
  • ๐Ÿ“‘ Files

Project arhitecture:

  • ๐Ÿ“’ api
    • ๐Ÿ“’ request-objects
    • ๐Ÿ“’ requests
  • ๐Ÿ“’ app
    • ๐Ÿ“’ login
      • ๐Ÿ“’ components
        • ๐Ÿ“‘ login-container.tsx
        • ๐Ÿ“‘ login.tsx
      • ๐Ÿ“’ actions
        • ๐Ÿ“‘ login-actions.ts
      • ๐Ÿ“’ reducers
        • ๐Ÿ“‘ login-reducers.ts
      • ๐Ÿ“’ constants
        • ๐Ÿ“‘ login-constants.ts
        • ๐Ÿ“‘ action-types.ts
      • ๐Ÿ“’ validators
        • ๐Ÿ“‘ validators.ts
  • ๐Ÿ“’ common
    • ๐Ÿ“’ images
    • ๐Ÿ“’ styles
    • ๐Ÿ“‘ constants.ts
    • ๐Ÿ“‘ routes-constants.ts
    • ๐Ÿ“‘ helpers.ts
  • ๐Ÿ“’ components
    • ๐Ÿ“’ button ๐Ÿ“‘ button.tsx ๐Ÿ“‘ button.scss
  • ๐Ÿ“’ core
    • ๐Ÿ“‘ axios-config.ts
    • ๐Ÿ“‘ root-reducer.ts
    • ๐Ÿ“‘ routes.ts
    • ๐Ÿ“‘ store.ts
  • ๐Ÿ“’ tests
  • ๐Ÿ“‘ package.json
  • ๐Ÿ“‘ README.md

Setting up project:

  • Install dependencies: yarn install

  • Start project: yarn start

  • Create a deployable build yarn build

  • Trigger tests yarn test

  • Trigger cypress tests yarn test-integration

  • Trigger cypress tests (silent mode) yarn test-integration-run

  • Start generator for generating feature boilerplate yarn generate

  • Start storybook yarn storybook

Testing: Cypress is configured for testing purposes. Also, react-testing-library is added in the list of the dev dependencies for unit testing.

Authors and contributors

  • Eldin Soljic - Sholja - Software Developer

See also the list of contributors who participated in this project.

Happy coding!

react-template-ts's People

Watchers

Eldin Soljic avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.