-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* docs(readme): write it * docs(package.json): complete package.json information
- Loading branch information
1 parent
f0f6a82
commit 5cf92dd
Showing
2 changed files
with
18 additions
and
35 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,56 +1,30 @@ | ||
# site-books-ember | ||
# L'Académie des Renards | ||
|
||
This README outlines the details of collaborating on this Ember application. | ||
A short introduction of this app could easily go here. | ||
This is the source code of my author website. It's a French-only website that introduces my novels, articles, and artworks. To be honest, the only reason it's public is because I use GitHub pages for deployment, but feel free to have a look. It's an Ember app building with Embroider. | ||
|
||
## Prerequisites | ||
|
||
You will need the following things properly installed on your computer. | ||
|
||
* [Git](https://git-scm.com/) | ||
* [Node.js](https://nodejs.org/) (with npm) | ||
* [Ember CLI](https://cli.emberjs.com/release/) | ||
* [Google Chrome](https://google.com/chrome/) | ||
|
||
## Installation | ||
|
||
* `git clone <repository-url>` this repository | ||
* `git clone git@github.com:BlueCutOfficial/site-books.git` | ||
* `cd site-books-ember` | ||
* `npm install` | ||
|
||
## Running / Development | ||
|
||
* `ember serve` | ||
* Visit your app at [http://localhost:4200](http://localhost:4200). | ||
* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests). | ||
|
||
### Code Generators | ||
|
||
Make use of the many generators for code, try `ember help generate` for more details | ||
|
||
### Running Tests | ||
|
||
* `ember test` | ||
* `ember test --server` | ||
|
||
### Linting | ||
|
||
* `npm run lint` | ||
* `npm run lint:fix` | ||
* `pnpm i` | ||
|
||
### Building | ||
## Running | ||
|
||
* `ember build` (development) | ||
* `ember build --environment production` (production) | ||
* `pnpm start` | ||
* Visit the app at [http://localhost:4200](http://localhost:4200). | ||
|
||
### Deploying | ||
|
||
Specify what it takes to deploy your app. | ||
Anything merged to `master` branch gets deployed to https://academie-des-renards.dunstetter.fr/ using GitHub actions. | ||
|
||
## Further Reading / Useful Links | ||
## Ember Links | ||
|
||
* [ember.js](https://emberjs.com/) | ||
* [ember-cli](https://cli.emberjs.com/release/) | ||
* Development Browser Extensions | ||
* [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi) | ||
* [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/) |
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