Skip to content
This repository was archived by the owner on Sep 8, 2021. It is now read-only.

Commit 7eff738

Browse files
committed
Merge pull request #3 from GoThinkster/rfc
RFC
2 parents 3b91f26 + e602a5c commit 7eff738

30 files changed

+34129
-3
lines changed

.gitignore

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
6+
# Runtime data
7+
pids
8+
*.pid
9+
*.seed
10+
11+
# Directory for instrumented libs generated by jscoverage/JSCover
12+
lib-cov
13+
14+
# Coverage directory used by tools like istanbul
15+
coverage
16+
17+
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
18+
.grunt
19+
20+
# node-waf configuration
21+
.lock-wscript
22+
23+
# Compiled binary addons (http://nodejs.org/api/addons.html)
24+
build/Release
25+
26+
# Dependency directory
27+
node_modules
28+
29+
# Optional npm cache directory
30+
.npm
31+
32+
# Optional REPL history
33+
.node_repl_history

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,23 @@
11
# Redux codebase containing real world examples (CRUD, auth, advanced patterns, etc)
2-
Originally created for this [GH issue](https://github.com/reactjs/redux/issues/1353). **Codebase ETA: April 18th.** Star/watch to receive updates.
2+
Originally created for this [GH issue](https://github.com/reactjs/redux/issues/1353). The codebase is now feature complete and the RFC is open. **Your input is greatly appreciated; please submit bug fixes via pull requests & feedback via issues**. Target for syndicating to the official redux repo is early May.
33

4+
We're currently working on some docs for the codebase (explaining where functionality is located, how it works, etc) but most things should be self explanatory if you have a minimal understanding of React/Redux.
45

5-
### Functionality overview
6+
## Getting started
67

7-
The example application is a social blogging site (i.e. a Medium.com clone) called "Conduit". It uses a custom API for all requests, including authentication. We're hosting a public version of this API for demo usage, but we also have a local Node server that users can download as well.
8+
You can view a live demo over at https://redux.productionready.io/
9+
10+
To get the frontend running locally:
11+
12+
- Clone this repo
13+
- `npm install` to install all req'd dependencies
14+
- `npm run watch` to have webpack bundle the JS files into /bin/main.js, then run `npm start`
15+
16+
For convenience, we have a live API server running at https://conduit.productionready.io/api for the application to make requests against. You can view [the API spec here](https://github.com/GoThinkster/productionready/blob/master/API.md) which contains all routes & responses for the server. We'll release the backend code in a few weeks should anyone be interested in it.
17+
18+
## Functionality overview
19+
20+
The example application is a social blogging site (i.e. a Medium.com clone) called "Conduit". It uses a custom API for all requests, including authentication. You can view a live demo over at https://redux.productionready.io/
821

922
**General functionality:**
1023

bin/index.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Conduit</title>
6+
<link href="//code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css" rel="stylesheet" type="text/css">
7+
<link href="//fonts.googleapis.com/css?family=Titillium+Web:700|Source+Serif+Pro:400,700|Merriweather+Sans:400,700|Source+Sans+Pro:400,300,600,700,300italic,400italic,600italic,700italic" rel="stylesheet" type="text/css">
8+
<link rel="stylesheet" href="https://demo.productionready.io/main.css">
9+
</head>
10+
<body>
11+
12+
<div id="main"></div>
13+
14+
<script src="main.js"></script>
15+
</body>
16+
</html>

0 commit comments

Comments
 (0)