Building a backend #20 #40

asiyani · 2017-06-01T22:22:59Z

This PR adds Nodejs and MongoDB as the backend to this project. Current functionality for this app is not disturbed. After running yarn start website works as it is working now.

New Folder structure
- Moved js, css and index.html file to the public folder.
- Added 3 new folders. server, config and test.
- server folder contains app.js, db and routes folder.
  - db folder contains schema/model for MongoDB database.
  - routes folder contains js files related to APIs and other web routes
- config folder got the configuration for dotenv to load Nodejs environment variables.
- Test folder got test files for nodejs & db. e.g. db.test.js

MongoDB model
- for now, there are 3 separate schemas
  - user -> user who is registered/logged in to curiosity website. (git authentication)
  - username -> Schema to store data related to usernames
  - Repository -> schema to store data related to repos.
- Ideally, we should combine username and repository schema for denormalization? but it depends on the type of query we will be doing. We should discuss that further.
Routes
- Just for testing and to get an idea about folder structure, I have created following routes.
  - GET /api/username/all -> will send username list as jason
  - GET /user, GET /user/login, GET /user/logout -> will just print message on web.
Configuration
- I have 2 separate files for dotenv settings. .dev.env and .test.env
- MONGODB_URI is different in both files because we don't want to run lots of test on main db.
Test
- I am using Mocha and expect for backend testing.
- Just a simple test added to make sure we are able to store data to MongoDB server.
  yarn run test-node
Readme
- I have updated README.md file for Getting Started Guide.

Please review this folder structure and code. let me know what you guys think?
is DB schema properties enough or we need some additional information? I think we should create another issue to discuss schema design.

alejandronanez

@asiyani thanks for the PR, that's a ton of work!

I have a couple of thoughts/concerns though.

The fact that you have to install MongoDB locally, I think a better approach for this would be to suggest the user to create a DB in a service like MLab and update the right info under any .env file.
Correct me if I'm wrong, but we should avoid hitting the DB for testing unless there's a really strong reason to do so. Maybe we can use sinon for mocking.

An ideal scenario will be to have a Docker container that has everything installed (MongoDB) but I think that's quite some work for one PR.

alejandronanez · 2017-06-01T22:42:16Z

test/db.test.js

+    accessToken: 'sadjkskajfeifhwgsjfksdfkmcoiwerkhdskfjksladjf',
+});
+
+let repo = new Repository({


You're modifying repo anywhere else, you can change this to a const

alejandronanez · 2017-06-01T22:42:59Z

test/db.test.js

+describe('Simple DB test', () => {
+    describe('User', () => {
+        it('Should save user to db', (done) => {
+            user.save().then((usr) => {


Are we hitting the DB here? If yes we should change things, maybe consider using sinon for mocking.

alejandronanez · 2017-06-01T22:43:50Z

test/db.test.js

+    language: 'Javascript',
+});
+
+describe('Simple DB test', () => {


Also we should try not to nest describe blocks, this can lead to unexpected behaviour if we ever need to use this

alejandronanez · 2017-06-01T22:44:29Z

test/db.test.js

+const { Username } = require('./../server/db/username');
+const { User } = require('./../server/db/user');
+
+// console.log(mongoose.connection.host);


This code should go away. No commented code here unless there's a super strong reason 👍

alejandronanez · 2017-06-01T22:45:05Z

server/db/username.js

+});
+
+
+let Username = mongoose.model('Username', usernameSchema);


I think we can use const in here.

alejandronanez · 2017-06-01T22:45:32Z

server/db/repositories.js

+});
+
+
+let Repository = mongoose.model('Repository', repositorySchema);


const instead of let

alejandronanez · 2017-06-01T22:46:36Z

config/config.js

+    process.env.NODE_ENV = 'dev';
+}
+
+let dotenv = require('dotenv').config({


const instead of let

alejandronanez · 2017-06-01T22:47:47Z

.gitignore

@@ -1 +1,2 @@
 node_modules
+.vscode


alejandronanez · 2017-06-01T22:48:25Z

README.md

+## Getting Started
+##### Pre-Installation Requirements
+###### Node
+- Download and install latest stable version of [Node](https://nodejs.org/en/download/).


I think we should specify what version are we using and add that to the package.json under "engines" too.

alejandronanez · 2017-06-01T22:48:47Z

README.md

+- Download and install latest stable version of [Node](https://nodejs.org/en/download/).
+
+###### MongoDb
+- Download and Install [MongoDB Community Edition](https://docs.mongodb.com/manual/installation/#mongodb-community-edition).


Same goes for Mongo, what version should we (everybody contributing) should use.

alejandronanez

Change Arrow functions to regular functions in tests.

alejandronanez · 2017-06-01T23:02:40Z

test/db.test.js

+    language: 'Javascript',
+});
+
+describe('Simple DB test', () => {


Also Mocha doesn't like arrow functions at all, we should move to function() { ... }. More info here https://mochajs.org/#arrow-functions

mubaris · 2017-06-02T01:29:53Z

@asiyani Cool work man 👍

@alejandronanez Should I wait for this PR to merge, so that I can work on Webpack

alejandronanez · 2017-06-02T02:14:37Z

@alejandronanez Should I wait for this PR to merge, so that I can work on Webpack

Yes sir!

alejandronanez · 2017-06-02T09:50:29Z

package.json

-    "dependencies": {}
+    "dependencies": {
+        "dotenv": "^4.0.0",
+        "expect": "^1.20.2",


This is a devDependency instead of a dependency

alejandronanez

We should discuss what's the best way to do tests + DB setup later.
Good work @asiyani just change that devpendency into devDependency

alejandronanez · 2017-06-02T12:36:27Z

@asiyani fix conflicts on index.html and we should be good to go 👍

asiyani · 2017-06-02T12:40:20Z

I didnt change anything in index.html just moved it to public folder...

…

On Fri, 2 Jun 2017, 1:36 pm Alejandro Ñáñez Ortiz, ***@***.***> wrote: @asiyani <https://github.com/asiyani> fix conflicts on index.html and we should be good to go 👍 — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#40 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AGz7sOoxkh_CsvCDjmvFtTvIyoCfoRnJks5sAAHLgaJpZM4NtnkN> .

alejandronanez · 2017-06-02T12:44:03Z

I didnt change anything in index.html just moved it to public folder...

Oh well, maybe that's the issue. Anyway we can't merge until that's resolved though :( Let me know if you have any issues with those conflicts maybe I can jump in.

asiyani · 2017-06-02T12:52:08Z

I need index.html in public folder, otherwise i need to create route for index.html
Ideally that file should be in public folder.
Do you want me too move it to root for now just to merge PR.and then we move it back to public folder?

alejandronanez · 2017-06-02T12:54:10Z

What merge conflict are you seeing? Feel free to change whatever you think is necessary to solve the conflict so we can merge your pr.

…

On Fri, Jun 2, 2017 at 7:52 AM Ashok ***@***.***> wrote: I need index.html in public folder, otherwise i need to create route for index.html Ideally that file should be in public folder. Do you want me too move it to root for now just to merge PR.and then we move it back to public folder? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#40 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAcYUk0ekBF1VnDGk1ugDbico3AUbgAdks5sAAV5gaJpZM4NtnkN> .

mubaris · 2017-06-02T14:04:13Z

@asiyani You moved the index.html to public folder. After I made a change in the original index.html. Therefore, the git mv didn't work properly. If you move the new index.html to public folder, it might work.

Thoughts @alejandronanez

alejandronanez · 2017-06-02T14:38:06Z

Yeah that makes sense!

…

On Fri, Jun 2, 2017 at 9:04 AM Mubaris NK ***@***.***> wrote: @asiyani <https://github.com/asiyani> You moved the index.html to public folder. After I made a change in the original index.html. Therefore, the git mv didn't work properly. If you move the new index.html to public folder, it might work. Thoughts @alejandronanez <https://github.com/alejandronanez> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#40 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAcYUpRTSHbqwry-C4Pr8Tes_RxxFr8Iks5sABZfgaJpZM4NtnkN> .

asiyani · 2017-06-02T17:25:01Z

conflicts are now resolved.

alejandronanez · 2017-06-03T02:49:38Z

Good stuff boys

asiyani and others added 11 commits May 31, 2017 21:18

rearranged folder structure to add node backend

b53fee8

added node/express to serve static files

9e461fa

Update README.md

66f996f

Move Emoji Files

a00a970

added db schema and simple test

92dc3ce

added dotenv and config folder

0362dc3

added private section in .env for future use

eff6655

added sample user and api route

f96576a

added Getting Started guide in README.md

2082e72

modified README.md file

5a19855

modified getting started in README.md

34dbe2b

alejandronanez suggested changes Jun 1, 2017

View reviewed changes

alejandronanez added this to In Progress in V2 Jun 1, 2017

alejandronanez mentioned this pull request Jun 1, 2017

Building a backend #20

Open

5 tasks

alejandronanez suggested changes Jun 1, 2017

View reviewed changes

code review suggestions changes

aa51be5

alejandronanez reviewed Jun 2, 2017

View reviewed changes

alejandronanez approved these changes Jun 2, 2017

View reviewed changes

moved some dependencies to devDependencies

d823742

raulvillares approved these changes Jun 2, 2017

View reviewed changes

Merge remote-tracking branch 'upstream/master'

84331d7

resolved conflicts

17fab19

mubaris merged commit 16ca70a into mubaris:v2 Jun 3, 2017

alejandronanez moved this from In Progress to Merged in V2 Jun 5, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Building a backend #20 #40

Building a backend #20 #40

asiyani commented Jun 1, 2017

alejandronanez left a comment

alejandronanez Jun 1, 2017 •

edited

Loading

alejandronanez Jun 1, 2017

alejandronanez Jun 1, 2017

alejandronanez Jun 1, 2017

alejandronanez Jun 1, 2017

alejandronanez Jun 1, 2017

alejandronanez Jun 1, 2017

alejandronanez Jun 1, 2017

alejandronanez Jun 1, 2017

alejandronanez Jun 1, 2017

alejandronanez left a comment

alejandronanez Jun 1, 2017

mubaris commented Jun 2, 2017

alejandronanez commented Jun 2, 2017

alejandronanez Jun 2, 2017

alejandronanez left a comment

alejandronanez commented Jun 2, 2017

asiyani commented Jun 2, 2017 via email

alejandronanez commented Jun 2, 2017

asiyani commented Jun 2, 2017

alejandronanez commented Jun 2, 2017 via email

mubaris commented Jun 2, 2017

alejandronanez commented Jun 2, 2017 via email

asiyani commented Jun 2, 2017

alejandronanez commented Jun 3, 2017

		});


		let Username = mongoose.model('Username', usernameSchema);

		});


		let Repository = mongoose.model('Repository', repositorySchema);

Building a backend #20 #40

Building a backend #20 #40

Conversation

asiyani commented Jun 1, 2017

alejandronanez left a comment

Choose a reason for hiding this comment

alejandronanez Jun 1, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alejandronanez left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mubaris commented Jun 2, 2017

alejandronanez commented Jun 2, 2017

Choose a reason for hiding this comment

alejandronanez left a comment

Choose a reason for hiding this comment

alejandronanez commented Jun 2, 2017

asiyani commented Jun 2, 2017 via email

alejandronanez commented Jun 2, 2017

asiyani commented Jun 2, 2017

alejandronanez commented Jun 2, 2017 via email

mubaris commented Jun 2, 2017

alejandronanez commented Jun 2, 2017 via email

asiyani commented Jun 2, 2017

alejandronanez commented Jun 3, 2017

alejandronanez Jun 1, 2017 •

edited

Loading