-
Notifications
You must be signed in to change notification settings - Fork 12
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
af2851d
commit ea99c96
Showing
1 changed file
with
49 additions
and
55 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,86 +1,80 @@ | ||
| # Project Title | ||
| # Stock | ||
|
|
||
| One Paragraph of project description goes here | ||
| Web application to manage items inventory, loans and more. | ||
|
|
||
| ## 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. | ||
| These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| What things you need to install the software and how to install them | ||
|
|
||
| ```text | ||
| Give examples | ||
| ``` | ||
| This project is developed on a AMP server with PHP 8.1 and MariaDB 10.4. | ||
| It is based on the CodeIgniter 4.x framework. | ||
|
|
||
| ### Installing | ||
|
|
||
| A step by step series of examples that tell you how to get a development env running | ||
|
|
||
| Say what the step will be | ||
|
|
||
| ```text | ||
| Give the example | ||
| 1. Download [our latest release](https://github.com/OrifInformatique/stock/releases) | ||
| 2. Unzip your download in your project's directory (in your local PHP server) | ||
| 3. Run "composer install" to download required packages (you have to install composer at first, you can [get it here](https://getcomposer.org/download/)) | ||
| 4. Create a copy of the "env_dist" file and rename it to .env, then adapt it to your server's parameters | ||
| ``` | ||
| FOR EXAMPLE | ||
| And repeat | ||
| [...] | ||
| ```text | ||
| until finished | ||
| ``` | ||
| CI_ENVIRONMENT = development | ||
| End with an example of getting some data out of the system or using it for a little demo | ||
| [...] | ||
| ## Running the tests | ||
| app.baseURL = 'http://localhost/stock/public/' | ||
| Explain how to run the automated tests for this system | ||
| [...] | ||
| ### Break down into end to end tests | ||
| database.default.hostname = localhost | ||
| database.default.database = stock | ||
| database.default.username = root | ||
| database.default.password = | ||
| database.default.DBDriver = MySQLi | ||
| Explain what these tests test and why | ||
| [...] | ||
| ```text | ||
| Give an example | ||
| ``` | ||
| 5. Generate a local database running CodeIgniter's spark migrate commands | ||
|
|
||
| ### And coding style tests | ||
|
|
||
| Explain what these tests test and why | ||
|
|
||
| ```text | ||
| Give an example | ||
| ```bash | ||
| php spark migrate -n Stock | ||
| php spark migrate -n User | ||
| ``` | ||
|
|
||
| ## Deployment | ||
|
|
||
| Add additional notes about how to deploy this on a live system | ||
| ## Upgrade Version 1.6 to Version 4.0 | ||
|
|
||
| This upgrade makes lot of changes as the application is adapted to new CodeIgniter 4.x. Please follow carefully these steps and try it in a test environment before. | ||
|
|
||
| 1. BE SURE TO HAVE A COMPLETE BACKUP OF YOUR APPLICATION (DATABASE AND FILES) | ||
| 2. With FTP connexion, remove all files and folder from the hosting server, except for the "uploads" folder | ||
| 3. With FTP connexion, upload all the content of Version 4.0 release to the hosting server | ||
| 4. Move the "uploads" folder from root to "public" folder | ||
| 5. Rename the .env_dist file to .env and adapt its content to your hosting environment | ||
| 6. Delete the orif/stock/Database/Migrations/restore_CI3_version folder | ||
| 7. Browse to APPLICATION_URL/stock/migrate/toCI4 | ||
| 8. Enter the password that you can find in orif/stock/Controllers/Migrate.php (line 49) and validate | ||
| 9. Delete the file orif/stock/Controllers/Migrate.php | ||
| 10. Delete the folder orif/stock/Views/migration | ||
| 11. Browse to the application and connect with an administrator account | ||
| 12. Browse to APPLICATION_URL/clean_images/index | ||
| 13. Click on "Yes" to execute the script which will clean up the items images | ||
| 14. Delete the file orif/stock/Controllers/Clean_images.php | ||
| 15. Delete the folder orif/stock/Views/admin/clean_images | ||
| 16. Delete the folder orif/stock/Commands | ||
| 17. VERIFY THAT ALL THE APPLICATION WORKS WELL | ||
|
|
||
| ## Built With | ||
|
|
||
| * [CodeIgniter](https://www.codeigniter.com/) - PHP framework | ||
| * [Bootstrap](https://getbootstrap.com/) - To simplify views design | ||
|
|
||
| ## 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). | ||
| * [CodeIgniter 4.x](https://www.codeigniter.com/) - PHP framework | ||
| * [Bootstrap](https://getbootstrap.com/) - Design library with personalized css | ||
|
|
||
| ## Authors | ||
|
|
||
| * **Orif, domaine informatique** - *Initiating and following the project* - [GitHub account](https://github.com/OrifInformatique) | ||
|
|
||
| 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 | ||
| See also the list of [contributors](https://github.com/OrifInformatique/stock/contributors) who participated in this project. |