https://github.com/petrbroz/test-submodules-backend-nodejs
https://github.com/petrbroz/test-submodules-backend-nodejs
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/petrbroz/test-submodules-backend-nodejs
- Owner: petrbroz
- Created: 2021-05-27T07:48:09.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-27T15:41:45.000Z (over 4 years ago)
- Last Synced: 2025-02-17T20:41:27.065Z (8 months ago)
- Language: JavaScript
- Size: 84 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# test-submodules-backend-nodejs
This is the Node.js backend part of an experimental Autodesk Forge sample app
that is split across multiple GitHub repositories, namely:
- Frontend (HTML, CSS, JavaScript): https://github.com/petrbroz/test-submodules-frontend
- Node.js backend: https://github.com/petrbroz/test-submodules-backend-nodejs
- .NET Core backend: https://github.com/petrbroz/test-submodules-backend-netcore
## Prerequisites
- [Autodesk Forge app](https://forge.autodesk.com/en/docs/oauth/v2/tutorials/create-app)
- [Node.js](https://nodejs.org) (LTS version)
- [Git](https://git-scm.com)
## Getting started
- Clone this repository **with submodules**:
```
git clone --recurse-submodules https://github.com/petrbroz/test-submodules-backend-nodejs
cd test-submodules-backend-nodejs
```
- Install Node.js dependencies: `npm install`
- Provide your Forge app client ID and secret via environment variables:
| Bash (macOS/Linux) | Command Prompt (Windows) |
|--------------------|--------------------------|
|`export FORGE_CLIENT_ID=your-client-id`
`export FORGE_CLIENT_SECRET=your-client-secret`|`set FORGE_CLIENT_ID=your-client-id`
`set FORGE_CLIENT_SECRET=your-client-secret`|
> Replace `your-client-id` and `your-client-secret` with your Forge app credentials.
- Run the server: `npm start`
### Visual Studio Code
If you're using [Visual Studio Code](https://code.visualstudio.com), make a copy the _.env\_template_ file
in the root folder, name it _.env_, and add your Forge client ID and client secret to it.
Now, you can run and debug your application from the editor using _Run_ > _Start Debugging_ or by pressing `f5`.
### Heroku Deployment
Heroku does [support git submodules](https://devcenter.heroku.com/articles/git-submodules)
when using the standard `git push heroku ` deployment, meaning that if you have
the [Heroku CLI tool](https://devcenter.heroku.com/articles/heroku-cli) installed, you can simply do:
```bash
heroku login
heroku create your-heroku-app
heroku git:remote -a your-heroku-app
heroku config:set -a your-heroku-app FORGE_CLIENT_ID=your-client-id
heroku config:set -a your-heroku-app FORGE_CLIENT_SECRET=your-client-secret
git push heroku master
```
> Replace `your-client-id` and `your-client-secret` with your Forge app credentials,
> and `your-heroku-app` with your own Heroku app name.
Note that linking your Heroku app directly to a GitHub repo will not work, as Heroku
cannot resolve git submodules in that case. To work around that limitation, you can
remove the git submodule and start versioning its files as part of this repo, as explained
[here](https://stackoverflow.com/questions/26752481/remove-git-submodule-but-keep-files).