{"id":16782328,"url":"https://github.com/denniseffing/mts-dishes","last_synced_at":"2025-03-16T21:22:21.845Z","repository":{"id":80527518,"uuid":"140480616","full_name":"denniseffing/mts-dishes","owner":"denniseffing","description":null,"archived":false,"fork":false,"pushed_at":"2018-09-21T15:14:40.000Z","size":1557,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-23T07:46:07.045Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/denniseffing.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-07-10T19:53:00.000Z","updated_at":"2018-09-17T15:39:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"d5eff942-c709-4631-861c-4295dee3b8b2","html_url":"https://github.com/denniseffing/mts-dishes","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denniseffing%2Fmts-dishes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denniseffing%2Fmts-dishes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denniseffing%2Fmts-dishes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denniseffing%2Fmts-dishes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/denniseffing","download_url":"https://codeload.github.com/denniseffing/mts-dishes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243933449,"owners_count":20370989,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-13T07:44:57.084Z","updated_at":"2025-03-16T21:22:21.819Z","avatar_url":"https://github.com/denniseffing.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Installation\n\n### Dependencies\n\nThe first command required for the installation is:\n\n    $ npm install\n\nor \n\n    $ yarn\n\nAlthough, for the environment to work properly, some packages have to be installed globally, so you have to execute these commands next:\n\n    $ npm install -g mocha\n\n    $ npm install -g ts-node\n\n    $ npm install -g typescript\n\n    $ npm install -g nodemon\n\nor\n\n    $ yarn global add mocha\n\n    $ yarn global add ts-node\n\n    $ yarn global add typescript\n\n    $ yarn global add nodemon\n\n## Config\n\nBefore build and execute the server, you must modify server configs. To do this you must edit the file src/config.ts.\n\n* secret: configure the secret word for jwt tokens.\n* mailConfig:  configure how the emails will be sent.\n    * api: usign the Jose's email program\n    * mock: printing the email at console\n    * both: api + mock\n    * none: do nothing\n* emailAPIaddr: route to email server\n* frontendURL: route to frontend server\n* serverURL: route to this server\n* databaseURL: route to database server\n\n## Build\n\nTo compile all typescript sources you should run:\n\n    $ npm run build\n\nor \n\n    $ yarn build\n\n## Database\n\nFirst of all, download DynamoDB in order to work with it in local: [http://docs.aws.amazon.com/...](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html)\n\n### Running DynamoDB Local:\n\nMove to the folder where you unzip the DynamoDB and run the command:\n\n    $ java -Djava.library.path=./DynamoDBLocal_lib -jar DynamoDBLocal.jar\n\n### Create tables:\n\nGo back to the project folder and run the command:\n\n    $ npm run database\n\nor\n\n    $ yarn database\n\n## Execution\n\n### Start\n\nTo switch on the server run the command:\n\n    $ npm run start\n\nor\n\n    $ yarn start\n\n## Testing\n\nBefore execute any test, you must create a new database for this purpose:\n\n    $ npm run database:test\n\nor\n\n    $ yarn database:test\n\nIn order to run all unit test, run the command:\n\n    $ npm run test\n\nor\n\n    $ yarn test\n\n## Debugging\n\nNot implemented yet.\n\n## Nodemon\n\nBuild and monitors the server, with the nodemon command instead of node:\n\n    $ npm run serve\n\nor\n\n    $ yarn serve\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdenniseffing%2Fmts-dishes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdenniseffing%2Fmts-dishes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdenniseffing%2Fmts-dishes/lists"}