This project is a simple app that provides a UI to search GitHub repositories using the GitHub Search API.
There are other implementations using React, Web Components and Vue.js v2.
- Built in TypeScript using Vue.js 3
- CSS pre-processed with Stylus
- Bundled using Webpack
- Provides a server using Node.js and Express
- Includes ESLint linter and Prettier code formater
- Includes configuration to be run in a Docker container
From the root directory inside your terminal run $ npm install
To start Webpack in watch mode and start the development server run $ npm start
Once it is ready visit http://localhost:3000 in your browser
First build the production bundle $ npm run build
Once finished, start the production server $ npm run serve
To stop the production server run $ npm run serve:stop
The project also comes with Docker configuration files, so it can be run using Docker. It uses the production version of the app. First it builds the scripts with Webpack, then it starts the pm2 server.
- First make sure you have Docker installed
- Run the command
$ npm run dockerwhich will download and install the dependencies and set up the container - Once finished, it will be available in http://localhost:3000
- To stop the container run the command:
$ npm run docker:stop - If the container needs to be built again, run the command
$ npm run docker:recreate
