https://github.com/storyforj/fervor

A batteries included, config lite, fullstack framework to build modern web apps
https://github.com/storyforj/fervor

apollo postgraphql progressive-enhancement progressive-web-app react universal-rendering

Last synced: 24 days ago
JSON representation

A batteries included, config lite, fullstack framework to build modern web apps

• Host: GitHub
• URL: https://github.com/storyforj/fervor
• Owner: storyforj
• License: mit
• Created: 2017-05-31T09:51:36.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-23T22:21:17.000Z (almost 2 years ago)
• Last Synced: 2024-04-15T08:05:35.957Z (8 months ago)
• Topics: apollo, postgraphql, progressive-enhancement, progressive-web-app, react, universal-rendering
• Language: JavaScript
• Homepage:
• Size: 5.4 MB
• Stars: 43
• Watchers: 6
• Forks: 3
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Fervor

----

[![Join the chat at https://gitter.im/fervorous/fervor](https://badges.gitter.im/fervorous/fervor.svg)](https://gitter.im/fervorous/fervor?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) ![Build Status](https://circleci.com/gh/storyforj/fervor.svg?style=shield)

![Fervor Logo](https://avatars2.githubusercontent.com/u/26048760?v=4&u=c900b5463478aa9e8937a8422721210d33a9b984&s=200)

**Example App**: https://github.com/fervorous/fervor-todo-mvc  

**Docs**: https://github.com/fervorous/fervor/wiki  

**Getting Started**: https://github.com/fervorous/fervor/wiki/Getting-Started  

A batteries included, config free, fullstack framework to build modern web apps. Just write your data migrations, throw some components together and we'll handle the rest. We know you want universal rendering, we know you want to *own* your own data, we know you don't really want to write your own APIs that just move some data from one place to another. We've automated all that away, integrated with all the best libraries in the node community.

Major Features:

----

1. Universal React

2. Auto generated GraphQL based on your Postgres schema

3. Data Migrations

3. Server and client rendered GraphQL

5. CSS Modules

6. Hot reloading

7. CLI

8. Service Worker Caching

9. Progressive Web App Ready

10. Code Splitting: Base bundles, routes and common files

How to Start

----

### Pre-requisites

1. PostgreSQL installed and running ([OSX guide](https://www.codementor.io/devops/tutorial/getting-started-postgresql-server-mac-osx), [Linux guide](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-16-04))

2. NodeJS installed - take a look at [NVM](https://github.com/creationix/nvm)

3. [Install Yarn](https://yarnpkg.com/en/docs/install) (Required - for now)

### Create a new app

1. `yarn global add fervor`

2. `fervor create [your app name]; cd [your app name]`

3. `yarn install`

4. Create a database (`createdb [appname]`), or update the .env file

5. `yarn start:dev`

Note - `fervor create` will create an app in the current directory, and use the current directory name as the name of the app.

### Some next steps

- Create some migrations using `fervor migrate:make [migration name]`

- Run the migrations using `fervor migrate:latest`, rollback using `fervor migrate:rollback`

- Have some fun with your auto generated graphql. Inspect by visiting `http://localhost:3000/admin/graphiql`

- Write some React components, and make your app look great!

- Deploy to heroku copying `app.json` from our example app. Also copy the heroku prebuild step from package.json

- Try out the production build locally by running `yarn build; yarn start:prod`

Contributors

----

Your name could be here too! Read CONTRIBUTING.md for more details

[](https://github.com/parris)