Git Product home page Git Product logo

spark-test's Introduction

SETTING UP THE PROJECT

  • If you have docker installed, make sure you are in the same directory as the docker-compose.yml file and run docker-compose up --build.

  • if you do not have docker installed but want to run the project using docker, follow [https://docs.docker.com/engine/install/] to install it.

  • If you do not want to user docker, follow the following steps:

    • Create a .env with variable names such as the ones in .env.api file
    • Make sure your postgres is running if you are using the local one
    • Run npm install to install dependencies
    • Run npx prisma migrate dev to apply migrations and create tables
    • Run npm run dev to get your application started
    • You can open another terminal and make sure you are in the spark folder, then run npx prisma studio to get a graphical view of your database.

THINGS TO KNOW

  1. The root folder contains a rest.http file that has all the available endpoints in the application.
  2. Endpoints that are labelled with must be authenticated, you have to be logged in to access them. With that, you need to use postman or other interfaces.
  3. Endpoints that are labelled with must be authenticated and autorized, you have to be logged in and be an admin to access them. With that, you need to use postman or other interfaces.
  4. In order for the email feature to work:
    • Update the EMAIL_USER, EMAIL_PASS, EMAIL_SERVICE with the approraite details
    • Comment out line 103 to 111 and lines 168 to 174 in auth.route.js file in the routes folder

ADDITIONAL TIME

  • If I had additional time, I would have written some test cases for some features.

spark-test's People

Contributors

priscilla-odame avatar

Watchers

 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.