Giter Club home page Giter Club logo

layout's Introduction

Layout

A component-based site builder made with React, NextJS and NodeJS.

Running Locally

Clone the repository and install modules:

npm install
# or
yarn

Start MongoDB and create a database called layout.

Add environment variables:

cp api/.env.example api/.env
cp www/.env.example www/.env
# Then add the required environment variables.

Start the frontend:

cd packages/www

npm run dev

Start the backend:

cd packages/api

npm run dev

Folder Structure

The site is broken up into interdependent packages with Lerna.

api

A Node server using express to interact with a MongoDB database.

components

React components compiled with Babel at built time to be used on the built sites.

renderer

Basically a custom implementation of the React component tree to generate either static HTML or a React component tree for a given page on a site. Also parses a custom styled components api and adds styles to the page.

sections

React components compiled with Babel at built time to be used on the built sites, meant to contain components.

util

Shared utility components between the frontend and backend.

www

The frontend of the app using NextJS.

Deploying

If any of the packages other than api or www run these commands in the root directory.

npm run update-packages

npm run publish-packges

SSH into the deployment server and navigate to the root directory. Then run:

git pull

npm run build

npm run restart

layout's People

Contributors

davecalnan avatar

Stargazers

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