Skip to content

Latest commit

 

History

History
140 lines (93 loc) · 3.5 KB

README.md

File metadata and controls

140 lines (93 loc) · 3.5 KB
Raw

image

prettier TypeScript

Reactivated.app is an open-source app that scans your JS dependencies every 4 hours and generates cool dashboards.

https://reactivated.app

Features

  • 🧩 Support for NPM dependencies
  • 🐙 Import your GitHub repositories
  • 🔋 Visualizing your project's health
  • 🔎 Detection of the framework used
  • 💅 Grouping the different dependencies by a common prefix
  • ✨ Beta Automated PR in a new branch with the up-to-date dependencies (⚠️only supporting yarn.lock : will be created even if there is a package-lock.json)

Demo

💪 Built with

We use TypeScript ❤️ for static typing

API

Front

Getting started

Prerequisites
  • IDE with TypeScript, Prettier and ESLint support
  • Node installed
  • Yarn installed

API

Installation

$ cd api
$ yarn
cp .env.dist .env.dev

Running the app

# watch mode
$ yarn start:dev

# start workers
yarn start:worker

# handle GitHub webhooks with Smee
$ yarn smee

The API should be available on http://localhost:3000 (the swagger doc is available on http://localhost:3000/swagger)

Webhook (GitHub API)

Forward the payload from GitHub API to our local dev API thanks to Smee.

smee --url https://smee.io/BVk7Sqmgj7fXXcV --path /webhooks/consume --port 3000

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Front

Installation and .env config

cd front
cp .env.dist .env
yarn

Run the app

yarn start

The app should be available on http://localhost:3007

Webpack config

We use customize-cra to add some additional configuration to Webpack. One of those configuration is aliases. Whenever creating a new folder in the src folder, make sure it's correctly configured in the Webpack configuration.

Build the app

yarn build

Contributing

  1. Fork this repository to your own GitHub account and then clone it to your local device
  2. Install the dependencies (follow these instructions for the API and Front)
  3. Start the app, build your new feature and submit your pull request

OR

Make a new issue according to this template