Git Product home page Git Product logo

app-be's Introduction

Test App

This project has been generated using the express for back end integration, vite-typescript for front end integration

Installation/deployment instructions

Depending on your preferred package manager, follow the instructions below to deploy your project.

Requirements: NodeJS 18. If you're using nvm, run nvm use to ensure you're using the same Node version in local and in your lambda's runtime.

Using NPM

  • Run npm i to install the project dependencies

Using Yarn

  • Run yarn to install the project dependencies

Test your service

This code base does not use any API since we are sending event through SocketIO. Please refer to this:

Locally

In order to test the function locally, run the following command:

  • npm run dev if you're using NPM
  • yarn dev if you're using Yarn

Template features

Project structure

The project code base is mainly located within the src folder. This folder is divided in:

  • index.ts: bootstrapping the whole application in typescript. The file will be built into Javascript in the dist folder .

Back-end:

├── dist
│   ├── index.js
├── src
│   ├── index.ts
├── package.json
├── tsconfig.json               # Typescript compiler configuration
├── tsconfig.paths.json         # Typescript paths

3rd party libraries

  • Socket.IO - using socket.io for communication between client and the dashboard as the backend act as a middleman
  • vite - using to build React application
  • express - using to build the backend

Environment Variables

  • PORT (Backend)

app-be's People

Contributors

tylercmcglobal 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.