-
Notifications
You must be signed in to change notification settings - Fork 207
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Provide attributes for git config #434
Merged
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
caebcd6
Provide attributes for git config
faustinoaq 108b6a4
Add git config data and development usage
faustinoaq 6cb1ebd
Fix installation section
faustinoaq 27fb645
Fix typo
faustinoaq 24d859e
Remove database condition
faustinoaq dc4e019
Add author and email to shard.yml
faustinoaq 00a3a72
Fix wrong var name
faustinoaq aa05f1f
Avoid empty `user.name` or `user.email`
faustinoaq c2ba81f
Use system
faustinoaq b86763c
Add type
faustinoaq 580d8f3
Mention amber encrypt and add mysql
faustinoaq 923215a
Remove variable
faustinoaq fe7823a
Fix default
faustinoaq 3109155
Clarify fetch code
faustinoaq File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,52 +1,87 @@ | ||
# <%= @name %> | ||
|
||
Your description here | ||
A new project using [Amber Framework](https://amberframework.org/) | ||
|
||
## Installation | ||
|
||
Install back-end and front-end dependencies. | ||
|
||
``` | ||
shards install | ||
npm install | ||
``` | ||
|
||
Configure the `config/environments/development.yml` and set the `database_url` with your credentials to your database. | ||
|
||
Then: | ||
|
||
```shellsession | ||
shards update | ||
``` | ||
amber db create migrate | ||
``` | ||
|
||
## Usage | ||
|
||
To run the demo: | ||
### Development | ||
|
||
To build crystal files: | ||
|
||
``` | ||
amber watch | ||
``` | ||
|
||
To build assets: | ||
|
||
``` | ||
npm run watch | ||
``` | ||
|
||
### Production | ||
|
||
To setup `AMBER_ENV`: | ||
|
||
```shellsession | ||
$ shards build src/<%= @name %>.cr | ||
./<%= @name %> | ||
``` | ||
export AMBER_ENV=production | ||
``` | ||
|
||
To build a production release: | ||
|
||
``` | ||
shards build --production --release <%= @name %> | ||
``` | ||
|
||
To build production assets: | ||
|
||
``` | ||
npm run release | ||
``` | ||
|
||
To use encrypted enviroment settings see [documentation](https://github.com/amberframework/online-docs/blob/master/getting-started/cli/encrypt.md#encrypt-command) | ||
|
||
## Docker Compose | ||
|
||
This will start an instance of postgres, migrate the database, | ||
This will start an instance of <%= @database == "pg" ? "postgres" : "mysql" %>, migrate the database, | ||
and launch the site at http://localhost:3000 | ||
|
||
```shellsession | ||
``` | ||
docker-compose up -d | ||
``` | ||
|
||
To view the logs: | ||
|
||
```shellsession | ||
``` | ||
docker-compose logs -f | ||
``` | ||
|
||
Note: The Docker images are compatible with Heroku. | ||
> Note: The Docker images are compatible with Heroku. | ||
|
||
## Contributing | ||
|
||
1. Fork it ( https://github.com/[your-github-name]/your_project/fork ) | ||
1. Fork it ( https://github.com/<%= @github_name %>/<%= @name %>/fork ) | ||
2. Create your feature branch (git checkout -b my-new-feature) | ||
3. Commit your changes (git commit -am 'Add some feature') | ||
4. Push to the branch (git push origin my-new-feature) | ||
5. Create a new Pull Request | ||
|
||
## Contributors | ||
|
||
- [your_github_name](https://github.com/your_github_name) your_name - creator, maintainer | ||
- [<%= @github_name %>](https://github.com/<%= @github_name %>) <%= @author %> - creator, maintainer |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this line still valid?, Should we add
amber encrypt
reference to this README too? What steps are needed to setupproduction.yml
? What about.encryption_key
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That might live nicely in a Deployment section
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@robacarp I added a link to
amber encrypt
documentation 👍