https://github.com/flight/vice

Sample Full-Stack application (NextJS + Firebase + Firestore + React + Typescript + TailwindCSS + CI / CD setup)
https://github.com/flight/vice

cypress eslint firebase firestore jest nextjs prettier react tailwindcss typescript

Last synced: 2 months ago
JSON representation

Sample Full-Stack application (NextJS + Firebase + Firestore + React + Typescript + TailwindCSS + CI / CD setup)

• Host: GitHub
• URL: https://github.com/flight/vice
• Owner: Flight
• Created: 2022-12-20T15:25:30.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-27T13:01:01.000Z (over 3 years ago)
• Last Synced: 2025-10-23T15:51:35.688Z (8 months ago)
• Topics: cypress, eslint, firebase, firestore, jest, nextjs, prettier, react, tailwindcss, typescript
• Language: TypeScript
• Homepage: https://vice-2ef34.web.app/
• Size: 5.23 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Vice Media Group Portforlio

Live url:

[https://vice-2ef34.web.app/](https://vice-2ef34.web.app/)

[NextJS](http://nextjs.org) + [React](https://reactjs.org) + [Typescript](https://www.typescriptlang.org) + [Tailwind CSS](https://tailwindcss.com) + [ESLint](https://eslint.org) + [Prettier](https://prettier.io) + [Husky](https://github.com/typicode/husky) + [Jest](https://jestjs.io) + [jest-dom (React Testing Library)](https://github.com/testing-library/jest-dom) + [Cypress](https://www.cypress.io)

Desktop:

![Vice Media Group Portforlio App Desktop](screenshots/app_desktop.png?raw=true)

Mobile:

![Vice Media Group Portforlio App Mobile](screenshots/app_mobile.png?raw=true)

## Initial setup:

1. Install the node.js

   https://nodejs.org/en/download/

2. Install the latest version of [pnpm package manager](https://pnpm.io/installation#using-npm)

   `npm install -g pnpm` or `brew install pnpm`

3. Install the dependencies

   `pnpm install && pnpm pre-commit:install`

## Running

`pnpm dev`

## Production build

`pnpm build`

To run the server with the production build:

`pnpm start`

## Testing

Live mode

`pnpm test`

E2E tests

`pnpm e2e`

Pre-commit checks

`pnpm pre-commit`

## Deploying to [Google Firebase](http://firebase.google.com):

Login:

`firebase login`

Deploy hosting and functions:

`firebase deploy`

## Design decisions

- [NextJS](https://nextjs.org) - React frameworks with Server Side Rendering and a lot of other features

- [Google Firebase](http://firebase.google.com) - The database and hosting from Google

- [Tailwind CSS](https://tailwindcss.com) + [PostCSS](http://postcss.org) for tree-shakable utility classes and minimum amount of hand-written CSS

- [ESLint](http://eslint.org) + [Prettier](http://prettier.io) for linting and prettifying the codeHusky for pre-commit hooks

- [Jest](https://jestjs.io) - Testing Framework with a focus on simplicity.

- [Cypress](http://cypress.io) + [Cypress Testing Library](https://testing-library.com/docs/cypress-testing-library/intro/) for the end-to-end testing

![Giphy search app](screenshots/database.png?raw=true)

![Giphy search app](screenshots/storage.png?raw=true)

![Giphy search app](screenshots/api.png?raw=true)