Git Product home page Git Product logo

app-next's Introduction

app-next

Coverage Status Bugs Code Smells Duplicated Lines (%) Lines of Code Maintainability Rating Quality Gate Status Reliability Rating Security Rating Technical Debt Vulnerabilities

Status: pre-alpha

We're aiming to have the app codebase converted to TypeScript and fully unit test covered. This repo serves as a way for us to work on the bigger more foundational parts of the app codebase, without interferance of the legacy parts.

New components introduced in this repo will land in the current codebase where applicable. Bugfixes will continue to happen on the current codebase, until this version is fully done and merged.

This version is in no way shape or form intended to be used in production environments.

Once this codebase is complete enough to be used as main front-end, it will be moved to a branch on the main directus/app repo at which point it will be released as an beta / RC until confirmed ready.

Goals

  • Have everything in TypeScript
  • Have full test coverage
  • Have as much of the components in Storybook as possible
  • Rely on global state the least amount possible

Contributing

If you want to help out in the new version, please open an issue to discuss what you would like to do before opening a pull request. This makes sure we don't do overlapping work or work on something that's not intended to be in the app.

Development

You need Node.js v10+ and Yarn.

After cloning the repo, run:

$ yarn # install all dependencies of the project

Scripts

yarn serve

Bundles the app in dev mode and watches for changes.

Combine this with the API_URL environment variable to point it to a running API instance to debug fully:

$ API_URL=https://local.api.com yarn serve

yarn storybook

Fires up an instance of Storybook and watches for changes. Very useful to develop individual components in isolation.

yarn test

Runs all Jest tests in the app. Add the --coverage flag to see a print of what test coverage you've achieved.

Please aim for 100% coverage for newly added code.

app-next's People

Contributors

benhaynes avatar dependabot-preview[bot] avatar jacobrienstra avatar nitwel avatar rijkvanzanten avatar wolfulus avatar

Watchers

 avatar  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.