-
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.
- Loading branch information
1 parent
98f6220
commit 818e5f5
Showing
2 changed files
with
18 additions
and
161 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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,88 +1,40 @@ | ||
# Project Title | ||
# Normalux.ch | ||
|
||
One Paragraph of project description goes here | ||
The best way to see what this project is is to try it by yourself. It only takes 45 seconds. | ||
|
||
## Getting Started | ||
https://www.normalux.ch/ | ||
|
||
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. | ||
## Getting Started | ||
|
||
### Prerequisites | ||
|
||
What things you need to install the software and how to install them | ||
|
||
``` | ||
Give examples | ||
``` | ||
- PHP 7.4 (PHP ⩾8.0 is not compatible ) | ||
- MySQL | ||
|
||
### Installing | ||
|
||
A step by step series of examples that tell you how to get a development env running | ||
|
||
Say what the step will be | ||
|
||
``` | ||
Give the example | ||
``` | ||
|
||
And repeat | ||
|
||
``` | ||
until finished | ||
``` | ||
|
||
End with an example of getting some data out of the system or using it for a little demo | ||
|
||
## Running the tests | ||
|
||
Explain how to run the automated tests for this system | ||
- Clone the repository and copy configs: | ||
|
||
### 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 | ||
```bash | ||
git clone https://github.com/BurkhalterY/normalux.ch.git | ||
cd normalux.ch/application/config/ | ||
cp config.php.sample config.php | ||
cp database.php.sample database.php | ||
``` | ||
|
||
## Deployment | ||
- Edit `database.php` with your MySQL credentials. | ||
- Manually create the database and import `database/normalux.sql` into it. | ||
|
||
Add additional notes about how to deploy this on a live system | ||
You can use an all-in-one solution such as XAMPP, UwAmp to run this project. Alternatively, you can use the following command in the repository root: `php7.4 -S 0.0.0.0:8000`. | ||
|
||
## Built With | ||
|
||
* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used | ||
* [Maven](https://maven.apache.org/) - Dependency Management | ||
* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds | ||
- [CodeIgniter 3](https://codeigniter.com/userguide3/) - the PHP framework | ||
|
||
## 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 | ||
This project is not actively maintained, but feel free to contribute. I'll read all issues and PR. | ||
|
||
## Acknowledgments | ||
|
||
* Hat tip to anyone whose code was used | ||
* Inspiration | ||
* etc | ||
|
||
- Pokédraw - A similar website belonging to the past. The original idea come from there. |