Skip to content

README.md

Latest commit

 

History

History
78 lines (62 loc) · 2.15 KB

README.md

File metadata and controls

78 lines (62 loc) · 2.15 KB

Intero Server

Server-side code and web application of the Intero home designer project.

Contributions welcome badge License badge

API Reference

Swagger Documentation containing information about all the endpoints is available here.

Setup locally

  1. Clone the project repository.
git clone https://github.com/fanton-dev/intero-server
cd intero-server
  1. Install nx and project decencies.
npm install -g nx
npm install
  1. Configure environment variables.

Rename the .env.template file to .env and fill-in the missing values.

  1. Start the applications

To bring up the intero-server run.

nx serve intero-server

To bring up the intero-web-client run.

nx serve intero-web-client

Setup using Docker

  1. Ensure you have Docker and docker-compose installed and running. In case you are having issues, you may refer to the Docker installation documentation.

  2. Clone the project repository.

git clone https://github.com/fanton-dev/intero-server
cd intero-server
  1. Start development server using Docker.
docker-compose up

Contributions

  1. Fork it (https://github.com/fanton-dev/intero-server/fork)
  2. Create your feature branch (git checkout -b feature-fooBar)
  3. Commit your changes (git commit -a)
  4. Push to the branch (git push origin feature-fooBar)
  5. Create a new Pull Request
  6. Upon review it will be merged.

License

Distributed under the BSD-3 Cause license. See LICENSE for more information.