Code Monkey home page Code Monkey logo

project-structure-sample's Introduction

Project Structure Sample

This repostory complements a medium post explaining a project structure focused on keeping back end and front end separated.

Getting Started

First thing you need to do is install dependencies:

$ npm install

Then you can run the SPA and the API in development mode (watching for changes) with:

$ npm start

And, if you have docker installed, you can dockerize it and run it with:

$ npm start:docker

web and api folders

Each folder has its own scripts you can run if you just want to work in one part of the app.

npm scripts

npm install

npm install will install the root folder (development) dependencies, and after that do the same with web dependencies and api dependencies.

npm start

npm start will run both subfolders' npm start in parallel using npm-run-all.

npm run build

npm run build will run both subfolders' npm run build in parallel.

npm run start:docker

npm run start:docker first call npm build then build, create and start two containers, one for node running the api, and the other running nginx serving the static SPA files and proxying all requests starting in /api/ to the node container.
After that it opens a browser on "http://localhost:8000/".

You can stop the containers with npm run stop:docker.

License

MIT © Hexacta

project-structure-sample's People

Contributors

jeffkandel avatar pomber avatar

Stargazers

 avatar

Watchers

 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.