readme.md 3.83 KB
Newer Older
1
# Asgard/Platform
Nicolas Widart's avatar
Nicolas Widart committed
2

3
This is the core repository for the Asgard CMS. The admin is fully translatable in English and French by default.
Nicolas Widart's avatar
Nicolas Widart committed
4 5

![](https://i.cloudup.com/WcLe-ORql4.thumb.png)
Nicolas Widart's avatar
Nicolas Widart committed
6

Nicolas Widart's avatar
Nicolas Widart committed
7
## Requirements
Nicolas Widart's avatar
Nicolas Widart committed
8

Nicolas Widart's avatar
Nicolas Widart committed
9
* PHP 5.4+
10 11 12 13 14 15 16

During the installation process you'll be prompted to either install [Cartalyst Sentinel](https://cartalyst.com/manual/sentinel/1.0?utm_source=asgard-cms&utm_medium=readme&utm_campaign=asgard-cms) or [Cartalyst Sentry](https://cartalyst.com/manual/sentry/2.1?utm_source=asgard-cms&utm_medium=readme&utm_campaign=asgard-cms).

If you choose to use Sentinel, you have to have access to Cartalyst's Arsenal. If you want to subscribe to Sentinel please check out their [Pricing plans](https://cartalyst.com/pricing?utm_source=asgard-cms&utm_medium=readme&utm_campaign=asgard-cms).

Since Cartalyst Sentinel isn't free, you can't use it for all projects, check out their [license page](https://cartalyst.com/license?utm_source=asgard-cms&utm_medium=readme&utm_campaign=asgard-cms) to know exactly what's permitted.

Nicolas Widart's avatar
Nicolas Widart committed
17
After the installation process you can also implement other User/Role drivers if needed. Refer to the documentation to know how.
Nicolas Widart's avatar
Nicolas Widart committed
18 19 20

## Getting started

Nicolas Widart's avatar
Nicolas Widart committed
21 22 23 24 25 26
### While in beta:

While AsgardCMS is in its beta period the above installation won't be available.

You have to clone this repository manually, run `composer install` and lastly `php artisan asgard:install` to start the installation process.

27 28
Please note that the current state of the CMS doesn't have the front-end yet. What you can test though, is the complete backend interface.

29 30 31 32 33 34 35
#### Feedback, ideas, etc.
If you have **feedback** to give, **ideas** you would like implemented, by all means share them on the [dedicated uservoice page](http://asgardcms.uservoice.com/). Do not hesitate to share!

For **issues/bugs** your having, you can use the Github Issues to post those. Each module has its own repository on the [AsgardCMS](https://github.com/AsgardCms) organisation, find the one that gives you problems, and sumbit an issue.

Thank you for your participation!

Nicolas Widart's avatar
Nicolas Widart committed
36 37 38
### Install Platform

```
39
composer create-project asgard/platform your-project-name --prefer-dist --stability=dev
Nicolas Widart's avatar
Nicolas Widart committed
40 41
```

42 43 44 45
### Run composer install

Run the usual `composer install` to get the dependencies.

46

47 48
## Run the install command

49
Now run `php artisan asgard:install` command to perform to start the installation process.
Nicolas Widart's avatar
Nicolas Widart committed
50

51
This install command will perform the following actions:
Nicolas Widart's avatar
Nicolas Widart committed
52

53 54 55 56 57
- Setup database information
- Running migrations
- Running seeds
- Publishing assets
- Create a first admin account
Nicolas Widart's avatar
Nicolas Widart committed
58

59

Nicolas Widart's avatar
Nicolas Widart committed
60 61
### Enjoy

62
You can now login on `/backend` with your email and password asked during the install command.
Nicolas Widart's avatar
Nicolas Widart committed
63 64


65 66
## Documentation

67
You can read the documentation on its specific [github repository](https://github.com/AsgardCms/Documentation).
68

Nicolas Widart's avatar
Nicolas Widart committed
69 70 71 72 73 74 75 76 77 78 79 80



## License (MIT)

Copyright (c) 2013 [Nicolas Widart](http://www.nicolaswidart.com) , n.widart@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.