Code Monkey home page Code Monkey logo

redwoodjs.com's Introduction

redwoodjs.com

This is the repo for https://redwoodjs.com

The content for the tutorial is pulled from TUTORIAL.md in this repo.

Other documentation is pulled from various READMEs in the main redwoodjs/redwood repo (see lib/build.js, the SECTIONS constant).

Local Development

This codebase is built with https://cameronjs.com and relies on plain HTML pages and Javascript with a couple helpers built in to abstract things like partials and layouts. We use https://stimulusjs.org for the few sprinkles of interactivity throughout the site.

Copy .env.example to a file named .env and get API keys/IDs for all of the service listed. Alternatively, if you don't care about populating search comment out the require statement for search.js in lib/build.js, the publishSearch() function call towards the end of the main() function, and the getObjectIDs() function call at the beginning of the main() function.

Then build the tutorial and doc pages:

yarn build

And to develop locally:

yarn dev

If you are already already running a yarn dev process when you yarn build you may need to stop and start yarn dev to pick up the new pages properly.

Contributing

Open a PR against the repo on GitHub. That will build and launch a copy of the site that you can get from the netlify/redwoodjs/deploy-preview check (click "Details" to open it):

image

Double check that your changes look good!

redwoodjs.com's People

Contributors

amrrkf avatar benmccann avatar cannikin avatar cball avatar colinscape avatar csellis avatar dfundingsland avatar gfpacheco avatar gjungb avatar guledali avatar hampuskraft avatar jrhorn424 avatar jtoar avatar jvanbaarsen avatar leonardoelias avatar matthewhembree avatar michelegera avatar mohsen1 avatar mojombo avatar osiux avatar peterp avatar robertbolender avatar ruralocity avatar shivamsinghchahar avatar terris avatar thedavidprice avatar tmr08c avatar tobbe avatar todor2810 avatar ybakos avatar

Watchers

 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.