Code Monkey home page Code Monkey logo

docs's Introduction

๐Ÿ“ The official daily.dev Documentation

The daily.dev docs are designed to help our community members get the most out of the product. Hope you will find it userful! 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:

$ 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

# or with pnpm
$ pnpm i

Run the local dev environment:

# with npm
$ npm run start

# or with yarn
$ yarn start

# or with pnpm
$ pnpm start

Now Visit:

http://localhost:3000

๐Ÿš€ Deployment

  • Build the project:
# with npm
$ npm run build

# or with yarn
$ yarn build

# or with pnpm
$ pnpm build
  • Run the server:
# 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:

$ docker compose up --build

The server is available by default on port 3000.

๐Ÿฟ Test

$ 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! โค๏ธ Contributors to daily.dev docs

๐Ÿ“‘ License

Licensed under AGPL-3.0.

โญ๏ธ One more thing

Don't forget to leave us a star โญ๏ธ

docs's People

Contributors

arvene241 avatar avneesh0612 avatar basefox avatar dammy001 avatar default-h avatar fi-krish avatar francescoxx avatar grahamthedev avatar idoshamun avatar just-moh-it avatar khushalarora avatar kishoreandra avatar lawrenceagles avatar leggetter avatar mao1910 avatar mr-destructive avatar nikhilxe avatar nimrodkra avatar niravprajapati1 avatar njmsaikat avatar njong392 avatar nxked avatar ombratteng avatar paaggeli avatar pradumnasaraf avatar ronlin1 avatar saptarshisarkar12 avatar shubh28698 avatar syedsohan avatar thisiskaransgit avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.