glorious-codes / glorious-crud

A bare minimum and extensible crud generator

Glorious Codes

Glorious Codes website

Contributing

1. Install Node. Download the "Recommend for Most Users" version.

2. Clone the repo:

git clone [email protected]:glorious-codes/glorious-codes.git

3. Go to the project directory

cd glorious-codes

4. Install the project dependencies

npm install

5. If you want to just build the project, run:

npm run build

6. Otherwise, run:

npm run start

The app runs on http://localhost:7000. The browser automatically reloads for any source file changes.

Tests

1. Ensure that all code that you have added is covered with unit tests:

npm run test

2. You can optionally generate coverage report after running tests:

npm run test -- --coverage

glorious-crud's Issues

Allow basic query params for get requests

Something like:

// resources/base.js
function getAllResources(collection, query, onComplete){
  const filter = buildFilterToGetAllResources(query);
  const order = query.order == 'asc' ? 1 : -1;
  const sort = query.sort ? {[query.sort]: order} : {};
  const limit = query.limit || 0;
  collection.find(filter).sort(sort).limit(parseInt(limit)).toArray((err, result) => {
    onGetComplete(err, result, onComplete);
  });
}

function buildFilterToGetAllResources(query){
  const filter = {};
  for(let key in query) {
    if(shouldAddQueryKeyToFilter(key))
      filter[key] = query[key];
  }
  return filter;
}

Such basic queries will automatically allow requests like that (getting the latest beer saved):
http://localhost:9000/beers?sort=createdAt&order=desc&limit=1

Make GET request navigable

At the moment, get requests respond with all results found. So, requests are taking very long for big amounts of data.
Make pagination enabled by default for any get requests. Suggestion:

1. List 30 results per page by default
2. Allow an optional query param called page.
3. Allow an optional query param called pageSize to change the default value for the number of results per page.
4. Include a link attribute in response header containing navigation details:
   • e.g.: Link: <https://api.github.com/users?page=2>; rel="next", <https://api.github.com/users?page=50>; rel="last"