{"id":18783384,"url":"https://github.com/futuresea-dev/sponteous","last_synced_at":"2026-04-02T02:51:22.333Z","repository":{"id":157980040,"uuid":"423315221","full_name":"futuresea-dev/sponteous","owner":"futuresea-dev","description":"sponteous MERN site","archived":false,"fork":false,"pushed_at":"2021-11-01T05:06:19.000Z","size":5644,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-29T11:44:40.761Z","etag":null,"topics":["css","docker","express","html","javascript","mongodb","nodejs","react","scss","shell","typescript"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/futuresea-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2021-11-01T02:37:10.000Z","updated_at":"2022-02-18T04:22:40.000Z","dependencies_parsed_at":"2024-08-26T22:50:53.226Z","dependency_job_id":null,"html_url":"https://github.com/futuresea-dev/sponteous","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/futuresea-dev%2Fsponteous","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/futuresea-dev%2Fsponteous/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/futuresea-dev%2Fsponteous/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/futuresea-dev%2Fsponteous/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/futuresea-dev","download_url":"https://codeload.github.com/futuresea-dev/sponteous/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239699578,"owners_count":19682574,"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":["css","docker","express","html","javascript","mongodb","nodejs","react","scss","shell","typescript"],"created_at":"2024-11-07T20:39:12.935Z","updated_at":"2025-12-20T14:30:14.921Z","avatar_url":"https://github.com/futuresea-dev.png","language":"JavaScript","readme":"In this project we're using our custom [Redvike Git Flow](https://github.com/Redvike/redvike-git-flow).\n\nTo run the project in the `development` environment you should:\n1. Go to the project's `./` folder and copy the environment variables. - `cp env.development.example .env`  \n2. Fill the `.env` file. For example, I have:\n\n```\n# The application's environment and port.\nAPP_ENV=development\nAPP_PORT=1337\n\n# The API documentation's port.\nAPI_DOCUMENTATION_PORT=1338\n\n# The Maildev's port.\nMAILDEV_PORT=1339\n\n# The NoSQLClient's port.\nNOSQLCLIENT_PORT=1340\n\n# The MongoDB's credentials.\nMONGO_INITDB_ROOT_USERNAME=username\nMONGO_INITDB_ROOT_PASSWORD=password\n```\n\n3. Go to the project's `./app/backend/` folder and copy the environment variables. - `cp env.development.example .env.development` \n4. Fill the `.env.development` file. For example, I have:\n```\n\n# JWT secret\nJWT_SECRET=test\n\n# Mail\nMAIL_FROM=\"viDent \u003cdev@redvike.com\u003e\"\nMAIL_SMTP_HOST=maildev\nMAIL_SMTP_PORT=3002\nMAIL_ROOT_URL=http://localhost:1337/#/\n\n# Redis\nREDIS_HOST=redis\nREDIS_PORT=6379\n\n# DB\nDB_USER=username\nDB_PASSWORD=password\nDB_HOST=mongo\nDB_PORT=27017\nDB_NAME=admin\n```\n\nTake into attention that `DB_NAME` must be set to `admin`.\n\n5. Go to the project's `./app/frontend/` folder and copy the environment variables- `cp env.development.example .env.development` .\n6. Fill the `.env.development` file. For example, I have:\n\n```\nREACT_APP_API_URL=http://localhost:1337/api\n```\n\nTake into attention that `REACT_APP_API_URL` must be set without trailing slash at the end.\n\n7. To serve the project you should go to the project's `./` folder and run:\n\n```\ndocker-compose -f docker-compose.yml -f docker-compose.development.yml up --build\n```\n\nThe Docker will serve the application and all the services on:\n- http://localhost:${APP_PORT}/ - frontend application\n- http://localhost:{APP_PORT}/api/ - backend application\n- http://localhost:{API_DOCUMENTATION_PORT}/ - API documentation\n- http://localhost:{MAILDEV_PORT}/ - MailDev client\n- http://localhost:{NOSQLCLIENT_PORT}/ - NoSQL client\n\nFor example, if you copied \u0026 pasted my environment variables, you would have:\n- http://localhost:1337/ - frontend application\n- http://localhost:1337/api/ - backend application\n- http://localhost:1338/ - API documenation\n- http://localhost:1339/ - MailDev client\n- http://localhost:1340/ - NoSQL client\n\nYou must install any packages inside the Docker container. Do not install any packages on your host machine. Also, you must run your tests inside the Docker container too. To enter the container you should go to the project's `./` folder and run:\n\n`docker-compose exec backend bash` - to enter the `backend` container\n`docker-compose exec frontend bash` - to enter the `frontend` container\n\nTo stop the Docker Compose, you should just press `CTRL + C` inside the terminal where the Docker Compose is running. Wait for all the containers to be stopped (it takes about 15 seconds). Do not close the terminal when Docker Compose is running. Do not press `CTRL + C` twice because it stops the containers forcefully (it can cause unexpected issues in the future). If something went wrong, and you are not able to `up` Docker Compose you should `down` all the container and volumes. Go to the project's `./` folder and run:\n\n```\ndocker-compose -f docker-compose.yml -f docker-compose.development.yml down -v\n```\n\nIf you are feeling comfortable with the Docker, you can extend or override our stack with `docker-compose.override.yml` file. Let's assume that you want to disable logs for MailDev and NoSQL client. To do that you should create `docker-compose.override.yml` file in the project's `./` folder and fill it with:\n\n```\n---\n# Define Docker Compose version.\nversion: \"3\"\n\n# Define all the containers.\nservices:\n  # Maildev container.\n  maildev:\n    logging:\n      driver: none\n  # Nosqlclient client container.\n  nosqlclient-client:\n    logging:\n      driver: none\n```\n\nTo run the Docker Compose with the `docker-compose.override.yml` file you should go to the project's `./` folder and run:\n\n```\ndocker-compose -f docker-compose.yml -f docker-compose.development.yml -f docker-compose.override.yml up --build\n```\n\nIn this case, you will extend the MailDev and NoSQL client services with the new `logging` directive.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffuturesea-dev%2Fsponteous","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffuturesea-dev%2Fsponteous","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffuturesea-dev%2Fsponteous/lists"}