This project consists in a Stack Overflow Brazilian Users listing, ordered by last access date. It was setup using @chittolina/fsts boilerplate.
You can check the current master (WIP) version here: https://fstsclg.herokuapp.com/
You can find the current development state following this README, on the Roadmap section.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
In order to correctly use the application please make sure you have these three working fine before we can get started:
yarn install
In order to start a development server, run (make sure your mongodb is running):
yarn dev:api
This will start the API at http://localhost:3000. You can open up a browser and try the following URL to see the API working:
http://localhost:3000/user
In order to serve the client files, run:
yarn dev:client
This will serve the files at http://localhost:1234
yarn build:api
This will output the API generated files under dist/api.
yarn build:client
This will output the client generated files under dist/client.
yarn test
NOTE: This will currently run tests for server side only.
- Create StackOverflow service
- List users by last access date in descending order
- Store only brazilian users on database
- Create tests for the Rate Limiter module
- Use typedoc to generate docs on API
- Use typedoc to generate docs on Client
- Add pagination to users listing
This project is licensed under the MIT License - see the LICENSE.md file for details