https://github.com/apsislabs/express_starter
https://github.com/apsislabs/express_starter
express starter-project
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/apsislabs/express_starter
- Owner: apsislabs
- Created: 2018-01-29T06:31:43.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-11T05:36:24.000Z (over 2 years ago)
- Last Synced: 2025-01-14T09:13:52.595Z (5 months ago)
- Topics: express, starter-project
- Language: TypeScript
- Size: 462 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# starterapp
## Setting up
1. pull the codebase
1. `bin/rename [your-app-name]` # your-app-name should be a npm friendly package name.
1. `rm bin/rename`
1. delete this `setting up` section of the readme
### Optional
#### Port Changes
The docker-compose maps the server to port `80` on the host. You may want to move it to a different port. Change the port mapping in the following files:
- `docker-compose.yml`
- `README.me` (just below in the `getting started` section)
## Getting Started
1. `docker-compose up`
2. visit `localhost:80`
3. rejoice!
## Developing
### Connection to the container
`bin/ssh_to_container`
### Running unit tests
From inside the container:
`npm test`
### Connecting to the database
From inside the container run:
`ops/psql.sh`
### Migrations
`npm run g:migration [name]`
Migrations will automatically be run up to latest on application startup.
To rollback a migration, run in the docker container: `npx knex migrate:rollback`. To rollback a single step run: `npx knex migration:down`.
### Recommended Reading
## The Containers
If you look in `docker-compose.yml` you'll notice that we've spun up a number of containers, not all of which may be useful for your project.
1. **server**: Your core container.
1. **db**: A postgres database.
1. **mailcatcher**: For viewing emails on your local environment. (disabled by default)
1. **localstack**: [`localstack`](https://github.com/localstack/localstack) is a suite of fake AWS services. (disabled by default)
1. **redis**: A `redis` instance. (disabled by default)
---
# Built by Apsis
[](https://www.apsis.io)
`express_starter` was built by Apsis Labs. We love sharing what we build! Check out our [other libraries on Github](https://github.com/apsislabs), and if you like our work you can [hire us](https://www.apsis.io/work-with-us/) to build your vision.