Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dailydotdev/docs
The official product docs of daily.dev
https://github.com/dailydotdev/docs
developer-tools documentation docusaurus hacktoberfest productivity
Last synced: 13 days ago
JSON representation
The official product docs of daily.dev
- Host: GitHub
- URL: https://github.com/dailydotdev/docs
- Owner: dailydotdev
- License: agpl-3.0
- Created: 2021-10-15T09:46:39.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T09:50:43.000Z (23 days ago)
- Last Synced: 2024-10-28T12:55:22.829Z (23 days ago)
- Topics: developer-tools, documentation, docusaurus, hacktoberfest, productivity
- Language: CSS
- Homepage: https://docs.daily.dev
- Size: 4.24 MB
- Stars: 332
- Watchers: 8
- Forks: 180
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 📝 The official daily.dev Documentation
The [daily.dev docs](https://docs.daily.dev/) are designed to help our community members get the most out of the product. Hope you will find it useful! We welcome your contribution to help us make it better and up-to-date 💜
## 👨💻 Contributing
- Contributions make the open source community such an amazing place to learn, inspire, and create.
- Any contributions you make are **truly appreciated**
- Provide clear documentation
- Create descriptive pull requests
- Test your changes
## 💻 Development
1. Fork the project: Click the gray `Fork` button in the top right of this page. This creates _your_ copy of the project and saves it as a new repository in your github account
2. Click on the green `Code` button, then either the HTTPS or SSH option and, click the icon to copy the URL. Now you have a copy of the project. Thus, you can play around with it locally on your computer.
3. Run the following commands into a terminal window (Command Prompt, Powershell, Terminal, Git Bash, ZSH):
Do this to download the forked copy of this repository to your computer:
```bash
git clone https://github.com/dailydotdev/docs.git
```
Step into the directory:
```bash
cd docs
```
Ensure you are on the correct node version:
```bash
nvm use
```
Install the dependencies:
```bash
# with npm
npm i
# or with yarn
yarn
# or with pnpm
pnpm i
```
Run the local dev environment:
```bash
# with npm
npm run start
# or with yarn
yarn start
# or with pnpm
pnpm start
```
Now Visit:
```
http://localhost:3000
```
## 🚀 Deployment
- Build the project:
```bash
# with npm
npm run build
# or with yarn
yarn build
# or with pnpm
pnpm build
```
- Run the server:
```bash
# with npm
npm run serve
# or with yarn
yarn serve
# or with pnpm
pnpm serve
```
The server is available by default on port `3000`.
## 🐳 Deployment with Docker
From the folder where the docker-compose.yml file is located, type:
```bash
docker compose up --build
```
The server is available by default on port `3000`.
## 🍿 Test
```bash
docker run -p 3000:3000 francescoxx/dailydev-docs:0.9.3
```
## 🙏 Thanks to all Contributors
Thanks a lot for spending your time in helping daily.dev grow. Thanks a lot! ❤️
## 📑 License
Licensed under [AGPL-3.0](https://github.com/dailydotdev/daily/blob/master/LICENSE).
## ⭐️ One more thing
Don't forget to leave us a star ⭐️