Skip to content

Commit

Permalink
Add CONTRIBUTING.md and update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
cefjoeii committed Sep 17, 2017
1 parent a8c45a9 commit 67d6d00
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 17 deletions.
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contributing to MERN CRUD

Thank you for considering contributing to this little project!

<br>

## Features you are encouraged to implement

* Tests
* Search
* Front-end validation (JS); Pure back-end validation is expensive
* Routing / redirecting / whatever
* Redux

## Coding conventions
* Indent using two spaces (soft tabs).
* Integrate *eslintrc.json* to your text editor or IDE.


<br>

## Fork, then clone the repo.
```bash
git clone https://github.com/<your-user-name>/mern-crud.git
```

## Commit
Make sure your commit messages are in present tense.

This:
```bash
git commit -m "Fix bugs and update colors"
```
Not this:
```bash
git commit -m "Fixed bugs and updated colours"
```

## Push to your Fork and make a pull request.
31 changes: 14 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ A simple records system using MongoDB, Express.js, React.js, and Node.js with re

![Node Version](https://img.shields.io/badge/node-v6.11.0-yellowgreen.svg)
![NPM Version](https://img.shields.io/badge/npm-v3.10.10-blue.svg)
![MongoDB Version](https://img.shields.io/badge/mongodb-v3.4.2-blue.svg)
![Mongoose Version](https://img.shields.io/badge/mongoose-v4.10.8-blue.svg)
![Language: American English](https://img.shields.io/badge/language-american%20english-red.svg)


Expand All @@ -13,9 +15,9 @@ Demo: [https://mern-crud.herokuapp.com/](https://mern-crud.herokuapp.com/)

## Instructions

Download or clone.
```
git clone https://github.com/cefjoeii/mern-crud.git
Fork, then download or clone the repo.
```bash
git clone https://github.com/<your-user-name>/mern-crud.git
```


Expand All @@ -29,12 +31,12 @@ module.exports = {
```

For the **back-end**, install the dependencies once via the terminal.
```
```bash
npm install
```

Run the *main server*. It listens on port 3000.
```
```bash
node server
```
View it on the browser.
Expand All @@ -43,17 +45,17 @@ View it on the browser.

If you want to configure the **front-end**, go to *react-src* folder via the terminal.

```
```bash
cd react-src
```

Install the dependencies required by React once.
```
```bash
npm install
```

Run the *development server* for React. It listens on port 4200.
```
```bash
npm start
```
Since it's running on a different port, we need to enable CORS. Locate the file called *server.js* on the root directory. Find and uncomment this line of code. Remember to comment it back out when deploying.
Expand All @@ -62,14 +64,17 @@ Since it's running on a different port, we need to enable CORS. Locate the file
```

To make a production build, simply run on *react-src* folder via the terminal.
```
```bash
npm run build
```

It re-creates a folder named *public* on the root directory. This is where the production-ready front-end of the web application resides.

<br>

## Contributing
* [CONTRIBUTING](CONTRIBUTING.md)

## To Do

- [x] Create
Expand All @@ -80,13 +85,5 @@ It re-creates a folder named *public* on the root directory. This is where the p
- [x] Deploy in Heroku
- [x] Front-end validation (HTML)

## Future Plans

* Search
* Front-end validation (JS); Pure back-end validation is expensive
* Routing / redirecting / whatever
* Learn Redux
* Learn creating tests

## License
* [MIT](LICENSE)

0 comments on commit 67d6d00

Please sign in to comment.