https://github.com/solidtime-io/docs
Documentation of the solidtime application
https://github.com/solidtime-io/docs
documentation
Last synced: 3 months ago
JSON representation
Documentation of the solidtime application
- Host: GitHub
- URL: https://github.com/solidtime-io/docs
- Owner: solidtime-io
- License: mit
- Created: 2024-04-28T17:14:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-11T10:34:38.000Z (4 months ago)
- Last Synced: 2025-04-09T06:49:49.879Z (3 months ago)
- Topics: documentation
- Language: TypeScript
- Homepage:
- Size: 1.16 MB
- Stars: 1
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# solidtime | Documentation
solidtime is a modern open-source time tracking application for freelancers and agencies.
This repository contains the documentation for solidtime.
The documentation is built using [Docusaurus](https://docusaurus.io/).
## Installation
First, clone the repository:
```bash
git clone [email protected]:solidtime-io/docs.git
```
Then, install the dependencies:
```bash
npm install
```
### Local Development
```bash
npm run start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Some features, like search and the API page, won't work in the local development environment. If you want to test this, you need to build the documentation and serve from the `build` directory.
### Build
```bash
npm run build
```
This command generates static content into the build directory.
You can test the build by running a local HTTP server:
```bash
npm run serve
```
## Contributing
Contributions to the documentation are welcome.
## License
The documentation is licensed under the MIT License. See [LICENSE](LICENSE.md) for more information.