Giter VIP home page Giter VIP logo

wlsf82 / engagesphere Goto Github PK

View Code? Open in Web Editor NEW
1.0 2.0 2.0 1.34 MB

The EngageSphere web application is aimed at our salespeople so they can access our customer's contact information.

Home Page: https://engage-sphere.vercel.app

License: MIT License

JavaScript 82.68% HTML 2.53% CSS 13.97% Dockerfile 0.83%
express javascript js nodejs react talking-about-testing react-components cypress testing heroku vercel docker dockerfile test-design test-design-masterclass test-design-masterclass-tat software-design elements-of-test-design component-testing test-automation

engagesphere's Introduction

EngageSphere

CI EngageSphere

Sample project with a Node.js backend and a React frontend, running Cypress tests on GitHub Actions.

Business rules

Read the following doc to understand all the EngageSphere application's functionalities.

Pre-requirements

To run this project, you will need:

  • git (I've used version 2.42.1 while writing this doc)
  • Node.js (I've used version v20.13.1 while writing this doc)
  • npm (I've used version 10.5.2 while writing this doc)

Note: When installing Node.js, npm is automatically installed too.

Installing and starting the servers

Read the following doc to install and start the backend and frontend servers.

Installation of devDependencies

After cloning this project, to install the dev dependencies, open a terminal, go to the root of this repo, and run npm install (or npm i, for short.)

Tests

This project has frontend component tests, GUI tests, and backend API tests.

To run them all, simply run npm test (or npm t, for short.)

Frontend component tests

Run npm run test:frontend:component to run the frontend component tests.

GUI tests

Run npm run test:frontend:gui to run the GUI tests.

To use the above script, both the backend and frontend servers should be up and running.

Or, run npm run test:frontend:gui:with:servers to automatically start the servers, run the tests, and shut them down.

The GUI tests include a small suite of accessibility (a11y) tests.

API tests

Run npm run test:api to run the backend tests.

To use the above script, both the backend and frontend servers should be up and running.

Note: Although these are backend tests, the frontend server needs to be running due to the baseUrl definition at the cypress.config.js file.

Or, run npm run test:api:with:servers to automatically start the servers, run the tests, and shut them down.

Test cases

Read the following doc to get a list of test cases.


Made with ❤️ by Walmyr.

engagesphere's People

Contributors

wlsf82 avatar dependabot[bot] avatar

Stargazers

Bruno Pulis avatar

Watchers

Lucian avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.