README & LICENSE

This commit is contained in:
Brieuc Dubois 2023-12-29 13:27:39 +01:00
parent aaef1cb67d
commit e38385cab5
2 changed files with 50 additions and 0 deletions

7
LICENSE.md Normal file
View File

@ -0,0 +1,7 @@
Copyright © 2023 Brieuc Dubois
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.

43
README.md Normal file
View File

@ -0,0 +1,43 @@
# Focus
> [!CAUTION]
> Focus is in alpha development stage. Expect breaking changes in every version.
Focus is an open-source, Kanban-style project management tool, emphasizing simplicity and efficiency. The backend is written in go and the frontend is in svelte.
## KISS Principles
Adhering to [KISS principles](https://en.wikipedia.org/wiki/KISS_principle), Focus boasts a minimalist, efficient codebase, concentrating on essential features. This streamlined approach minimizes complexity, enhancing maintainability and ease of deployment across different architectures.
Certain features are intentionally excluded, left to specialized tools. These include:
- Authentication
- HTTPS
- Notifications
- Mobile App
Focus offers a comprehensive RESTful API for extensions and integrations.
## Launching Focus in Debug Mode
To run Focus locally, follow these steps:
1. Clone the repository:
```sh
git clone https://git.bhasher.com/Bhasher/focus
```
2. Start the backend:
```sh
cd backend
go run .
```
3. Start the frontend:
```sh
cd frontend
npm run dev
```
4. Access Focus at http://localhost:5000. The API is at http://localhost:3000.
## License
Focus is under the MIT License. For details, see the [LICENSE](license.md) file.