Skip to content

Commit

Permalink
update to README file
Browse files Browse the repository at this point in the history
The README file now contains proper instruction on how to setup this project locally
  • Loading branch information
Edward Osaretin Oboh committed Aug 28, 2021
1 parent 37ad00c commit bfcd360
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 10 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
## Zuri Chat Company Files Plugin

### Overview
...
Company files management plugin for Zuri Chat.


### Local Setup Instruction
1. Ensure nodejs and git are installed in machine
2. Clone this repo using `git clone https://github.com/zurichat/zc_plugin_company_files.git`
3. Change directory into the new clone `cd zc_plugin_company_files`
4. Run setup script to install all packages using `npm run install-setup`
5. Now run server in delelopment mode with `npm run dev`
PS: You may need to have yarn already install

### Dev Contribution Guide
1. Fork the repository
2. Clone and then open it up on your prefered code editor
3. Open your terminal & set the upstream branch: git remote add upstream `https://github.com/zurichat/zc_plugin_company_files.git`
3. Open your terminal & set the upstream branch: `git remote add upstream https://github.com/zurichat/zc_plugin_company_files.git`
4. Pull upstream `git pull upstream main`
5. Create a new branch for the user story you're working on eg : `git checkout -b feat-import-file-from-url`
6. After making changes, do `git add .`
Expand Down
2 changes: 1 addition & 1 deletion frontend/src/App.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ function App() {
<header className="App-header">
<img src="/zurichatlogo.svg" />
<h2>
Team: GALILOE
Team: GALILEO
</h2>
<h4>
Plug-in: COMPANY FILES
Expand Down
8 changes: 3 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@
"description": "Zuri chat company files management plug-in",
"main": "server.js",
"scripts": {
"start": "cd frontend && yarn build && yarn start && node server.js",
"server": "nodemon server.js",
"client": "cd frontend && yarn build && yarn start",
"dev": "concurrently \"npm run server\" \"npm run client\"",
"install": "npm install && npm install --prefix client"
"start": "cd frontend && yarn build && cd .. && node server.js",
"dev": "nodemon server.js",
"install-setup": "npm install && cd frontend && yarn install"
},
"repository": {
"type": "git",
Expand Down
4 changes: 2 additions & 2 deletions server.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ app.use(express.json());


// if (process.env.NODE_ENV === "production") {
app.use(express.static("client/build"));
app.use(express.static("frontend/build"));
app.get("*", (req, res) => {
res.sendFile(path.resolve(__dirname, "client", "build", "index.html"));
res.sendFile(path.resolve(__dirname, "frontend", "build", "index.html"));
});
// }

Expand Down

0 comments on commit bfcd360

Please sign in to comment.