85 lines
5.3 KiB
Markdown
85 lines
5.3 KiB
Markdown
#  *PATHFINDER*
|
||
#### Mapping tool for [*EVE ONLINE*](https://www.eveonline.com)
|
||
|
||
- Project URL [https://www.pathfinder-w.space](https://www.pathfinder-w.space)
|
||
- Screenshots [imgur.com](http://imgur.com/a/k2aVa)
|
||
- Videos [youtube.com](https://www.youtube.com/channel/UC7HU7XEoMbqRwqxDTbMjSPg)
|
||
- Licence [MIT](http://opensource.org/licenses/MIT)
|
||
|
||
#### Development
|
||
- Test server: [https://www.dev.pathfinder-w.space](https://www.dev.pathfinder-w.space)
|
||
- Running current `develop` branch
|
||
- _SISI_ _ESI_ (make sure to use your test-server client)
|
||
- Available for public testing (e.g. new feature,… )
|
||
- Database will be cleared from time to time
|
||
- Installation guide:
|
||
- [wiki](https://github.com/exodus4d/pathfinder/wiki)
|
||
- Developer [Slack](https://slack.com) chat:
|
||
- https://pathfinder-eve-online.slack.com
|
||
- Join channel [pathfinder-eve-online.slack.com](https://join.slack.com/t/pathfinder-eve-online/shared_invite/enQtMzMyOTkyMjczMTA3LWI2NGE1OTY5ODBmNDZlMDY3MDIzYjk5ZTljM2JjZjIwNDRkNzMyMTEwMDUzOGQwM2E3ZjE1NGEwNThlMzYzY2Y)
|
||
- Can´t join? pathfinder@exodus4d.de
|
||
|
||
**Feel free to check the code for bugs and security issues.
|
||
Issues should be reported in the [Issue](https://github.com/exodus4d/pathfinder/issues) section.**
|
||
|
||
***
|
||
|
||
### Project structure
|
||
<pre>
|
||
─╮
|
||
├─ app/ [0755] → PHP root
|
||
│ ├─ Controller/ → controller classes for app/ajax endpoints (see routes.ini)
|
||
│ ├─ Cron/ → controller classes cronjob endpoints (see cron.ini)
|
||
│ ├─ Data/ → classes for data handling
|
||
│ ├─ Db/ → classes for DB handling
|
||
│ ├─ Exception/ → custom exceptions
|
||
│ ├─ Lib/ → libs
|
||
│ ├─ Model/ → ORM
|
||
│ ├─ config.ini → config - F3 core config: <a href="//fatfreeframework.com/3.7/quick-reference#SystemVariables" title="Fat-Free Framework - SystemVariables">SystemVariables</a>
|
||
│ ├─ cron.ini → config - cronjobs
|
||
│ ├─ environment.ini → config - system environment
|
||
│ ├─ pathfinder.ini → config - pathfinder
|
||
│ ├─ plugin.ini → config - custom plugins
|
||
│ ├─ requirements.ini → config - system requirements
|
||
│ └─ routes.ini → config - routes
|
||
├─ export/ [0755] → static data
|
||
│ ├─ csv/ → *.csv used by /setup page
|
||
│ └─ sql/ → DB dump for import (eve_universe.sql.zip)
|
||
├─ favicon/ [0755] → favicons
|
||
├─ history/ [0777] → log files (map history logs) [optional]
|
||
├─ js/ [0755] → JS source files (not used for production)
|
||
│ ├─ app/ → "PATHFINDER" core files
|
||
│ ├─ lib/ → 3rd party libs
|
||
│ └─ app.js → require.js config
|
||
├─ logs/ [0777] → log files
|
||
│ └─ …
|
||
├─ public/ [0755] → static resources
|
||
│ ├─ css/ → CSS dist/build folder (minified)
|
||
│ ├─ fonts/ → icon-/fonts
|
||
│ ├─ img/ → images
|
||
│ ├─ js/ → JS dist/build folder and source maps (minified, uglified)
|
||
│ └─ templates/ → templates
|
||
├─ sass/ → SCSS sources (not used for production)
|
||
├─ tmp/ [0777] → cache folder (PHP templates)
|
||
│ └─ cache/ [0777] → cache folder (PHP cache)
|
||
├─ .htaccess [0755] → reroute/caching rules ("Apache" only!)
|
||
└─ index.php [0755]
|
||
|
||
━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||
CI/CD config files:
|
||
|
||
├─ .jshintrc → "JSHint" config (not used for production)
|
||
├─ composer.json → "Composer" package definition
|
||
├─ gulpfile.js → "Gulp" task config (not used for production)
|
||
├─ package.json → "Node.js" dependency config (not used for production)
|
||
└─ README.md → This file :) (not used for production)
|
||
</pre>
|
||
|
||
***
|
||
|
||
### Contributing
|
||
|
||
[](https://sourcerer.io/fame/exodus4d/exodus4d/pathfinder/links/0)[](https://sourcerer.io/fame/exodus4d/exodus4d/pathfinder/links/1)[](https://sourcerer.io/fame/exodus4d/exodus4d/pathfinder/links/2)[](https://sourcerer.io/fame/exodus4d/exodus4d/pathfinder/links/3)[](https://sourcerer.io/fame/exodus4d/exodus4d/pathfinder/links/4)[](https://sourcerer.io/fame/exodus4d/exodus4d/pathfinder/links/5)[](https://sourcerer.io/fame/exodus4d/exodus4d/pathfinder/links/6)[](https://sourcerer.io/fame/exodus4d/exodus4d/pathfinder/links/7)
|
||
|
||
|