Skip to content

Commit

Permalink
update readme + ss (#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
bmiddha authored Apr 30, 2021
1 parent ca6d856 commit 195b189
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 27 deletions.
34 changes: 7 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,11 @@
</p>

<p align='center'>
<a href='https://final-countdown.azurewebsites.net'>
<img src='https://img.shields.io/website?label=release&url=https%3A%2F%2Ffinal-countdown.azurewebsites.net%2F' alt='Release' />
<a href='https://finals.acmuic.app'>
<img src='https://img.shields.io/website?label=release&url=https%3A%2F%2Ffinals.acmuic.app%2F' alt='Release' />
</a>
<a href='https://github.com/bmiddha/final-countdown/actions?query=workflow%3A%22Node+CI%22'>
<img src='https://img.shields.io/github/workflow/status/bmiddha/final-countdown/Node%20CI?label=build:%20Node%20CI' alt='build status' />
</a>
<a href='https://github.com/bmiddha/final-countdown/actions?query=workflow%3A%22Docker+CI%22'>
<img src='https://img.shields.io/github/workflow/status/bmiddha/final-countdown/Docker%20CI?label=build:%20Docker%20CI' alt='build status' />
</a>
<a href='https://github.com/bmiddha/final-countdown/actions?query=workflow%3A%22Docker+CD+-+main%22'>
<img src='https://img.shields.io/github/workflow/status/bmiddha/final-countdown/Docker%20CD?label=build:%20Docker%20CD%20-%20main' alt='build status' />
<a href='https://github.com/bmiddha/final-countdown/actions/workflows/build.yml'>
<img src='https://github.com/bmiddha/final-countdown/actions/workflows/build.yml/badge.svg' alt='CI Build'>
</a>
<a href='https://github.com/bmiddha/final-countdown/blob/main/LICENSE'>
<img src='https://img.shields.io/github/license/bmiddha/final-countdown' alt='license' />
Expand All @@ -24,30 +18,16 @@

Final Exam Schedule for UIC with countdowns.

This is a progressive web app (PWA) written in [TypeScript](https://www.typescriptlang.org/) and [React.js](https://reactjs.org/).

## Deployments

Public Docker Images: [hub.docker.com/r/bmiddha/final-countdown](https://hub.docker.com/r/bmiddha/final-countdown).
This is a progressive web app (PWA) written in [TypeScript](https://www.typescriptlang.org/) and [Next.js](https://nextjs.org/).

## Screenshots

![Screenshot](https://github.com/bmiddha/final-countdown/raw/main/screenshots/ss-1.png)

## Getting Started

- Dependencies: `npm install`
- Building: `npm run build`
- Developing: `npm run start`

## Docker Deployment

The [bmiddha/final-countdown](https://hub.docker.com/r/bmiddha/final-countdown) docker image is _tiny_ and runs a production ready app in NGINX.

```sh
docker pull bmiddha/final-countdown:latest
docker run -it --rm -p 8080:80 bmiddha/final-countdown:latest
```
- Dependencies: `yarn install`
- Developing: `yarn dev`

## Contributing

Expand Down
Binary file modified screenshots/ss-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 195b189

@vercel
Copy link

@vercel vercel bot commented on 195b189 Apr 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.