cypress-io / birdboard

Example Twitter client web app shown in Cypress in a Nutshell webcast.

BirdBoard

Simple example Twitter client to demonstrate some core Cypress concepts as seen within the 📺 Cypress In A Nutshell webcast.

• The frontend is implement with Vue, Vuex, Vue Router, and Vuetify.
• The backend provides an API via an Express server, and data is stored within MongoDB instance.

Project setup

1. Install a local instance of MongoDB. Check the installation docs for your operating system.

   If you're using macOS you can quickly have a MongoDB instance via the MongoDB.app

2. (Optional) If you actually want to load real tweets from Twitter, you'll need to grab a Twitter API keys, and place them within /src/server/twitter.js file.

   const twitter = new TwitterAPI({
     consumer_key: '',
     consumer_secret: '',
     access_token_key: '',
     access_token_secret: ''
   })

3. Install dependencies:

   npm install
   

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Open Cypress desktop app

npx cypress open

Headlessly run Cypress tests

npx cypress run

Lints and fixes files

npm run lint

Customize configuration

See Configuration Reference.