nitishmalang/docs

The official product docs of daily.dev

👨‍💻 Contributing

• Contributions make the open source community such an amazing place to learn, inspire, and create.
• Any contributions you make are truly appreciated

📝 daily.dev Documentation

💻 Development

• 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

• 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.

• 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.

$ git clone https://github.com/dailydotdev/docs.git

Step into the directory:

$ cd docs

Install the dependencies:

// with npm
$ npm i

// or with yarn
$ yarn

Run the local dev environment:

// with npm
$ npm run start

// or with yarn
$ yarn start

Now Visit:

http://localhost:3000

🚀 Deployment

• Build the project:

// with npm
$ npm run build

// or with yarn
$ yarn build

• Run the server:

// with npm
$ npm run serve

// or with yarn
$ yarn 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:

$ docker compose up --build

The server is available by default on port 3000.

👨‍💻 Test it

$ docker run -p 3000:3000 francescoxx/dailydev-docs:0.9.3

💪 Thanks to all Contributors

Thanks a lot for spending your time helping daily.dev grow. Thanks a lot! ❤️

📑 License

Licensed under AGPL-3.0.

🙏 Support

This project needs a ⭐️ from you. Don't forget to leave a star ⭐️