Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/selenesoftware/selenesite
The static builder files for selenesoftware.us using SeleneStatic.
https://github.com/selenesoftware/selenesite
Last synced: about 9 hours ago
JSON representation
The static builder files for selenesoftware.us using SeleneStatic.
- Host: GitHub
- URL: https://github.com/selenesoftware/selenesite
- Owner: SeleneSoftware
- Created: 2015-11-13T01:59:50.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-09-30T19:18:19.000Z (about 2 years ago)
- Last Synced: 2023-03-22T11:55:51.672Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://selenesoftware.us
- Size: 27.2 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE-2.0.txt
Awesome Lists containing this project
README
# Selene Static Builder
A rather small static site builder built from Twig and MArkdown that isn't blog centric.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
Composer
Yarn
PHP 7.2+
```
```
### Installing
A step by step series of examples that tell you how to get a development env running
Say what the step will be
composer create-project selenesoftware/seleneSite
```
```
## Running the tests
Explain how to run the automated tests for this system
I don't have tests for this. It is so small, tests would seem larger than the actual code. Don't want that.
### Break down into end to end tests
Explain what these tests test and why
```
Give an example
```
### And coding style tests
Explain what these tests test and why
```
Give an example
```
## Deployment
Once you run bin/app.php there will be files created in the 'web' directory. Then run yarn build and you have production ready files. Drop everything in the 'web' directory into your production environment.
## Built With
* [Twig](https://twig.symfony.com) - The rendering engine used
* [Composer](https://getcomposer.org) - Dependency Management
* [Yarn](https://yarnpkg.com) - Frontend depenceny management
* [Symfony Encore](https://symfony.com/doc/current/frontend/encore/installation-no-flex.html) - Asset Bundling
## Contributing
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
## Authors
* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)
See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
* Hat tip to anyone whose code was used
* Inspiration
* etc