Skip to content

Latest commit

 

History

History
84 lines (67 loc) · 3.25 KB

README.md

File metadata and controls

84 lines (67 loc) · 3.25 KB
Raw

aircto-assignments-16_08

Steps to run this repo

  1. Setup DB address
    a. Give the proper db connection address in src/aircto/model/init.go file.
    b. sql.Open("mysql", "homestead:secret@tcp([192.168.11.11]:3306)/")
    c. Replace your db connection address here.

  2. Run the DB Migration at first instant
    a. Navigate to mani@Mani:~/aircto-assignments-16_08/src$ project directory.
    b. Run go run aircto/migration/run_migration.go
    c. Now the Database and user, issues tables created with some user and issue seed data. d. There is no API to create user, please use the seed user data. You can find all the user list from here http://localhost:3011/api/users

  3. Run the code.
    a. Navigate to mani@Mani:~/aircto-assignments-16_08/src$ project directory.
    b. Run go run aircto/main.go
    b. Now the server started to serve in http://localhost:3011/api/

  4. Available API to test.

    # The following API's no need of any authendication/access token
	1. http://localhost:3011/api/
	2. http://localhost:3011/api/users
	3. http://localhost:3011/api/login
	<br />
# After login access token will be provided for the user, need to send access token along with the request.
	1. http://localhost:3011/api/issues // get - all issues
	2. http://localhost:3011/api/issue/{issueID:[0-9]+} // get - issue details
	3. http://localhost:3011/api/issue // post - create issue
	4. http://localhost:3011/api/issue/{issueID:[0-9]+} // put - update issue info
	5. http://localhost:3011/api/issue/{issueID:[0-9]+} // delete - delete issue
	6. http://localhost:3011/api/issues-by-me
	7. http://localhost:3011/api/issues-for-me

	Every issue created or updated mail will send to the assigned user with issue info.
	Cron Job for generate report mail to all the user.

  5. Need more info on the API, please refer the following Postman Document.
    Note: Limited lifetime to this document.

    1. https://documenter.getpostman.com/view/1310922/aircto-microservice/6n8wBGe
      Postman Collection:
    2. https://www.getpostman.com/collections/022cc4f7c3f135e80259

Please reach me out for more clarification @ manigandan.jeff@gmail.com, 9578628779, Skype: manigandan.dharmalingam

Simple-Issue-Tracker-V2-SIT-

Design: System will have two models called User and Issue. With following information

#1. User

a. Email b. Username c. FirstName d. LastName e. Password f. AccessToken

#2. Issue

  1. Title
  2. Description
  3. AssignedTo (User relation)
  4. Createdby (User relation)
  5. Status (Open, Closed)

Problem Statement: Expose a RESTful API to make CRUD operation of Issue resource.

  1. Every endpoint need user authentication
  2. Authentication should be stateless (access_token)
  3. User who created the issue only should be able to edit or delete that issue

Note:

  1. Whenever an Issue is created or assigned to different user(in case of update), an email should be triggered exactly after 12 mins to the particular user saying issue has been assigned to him/her.
  2. Every 24 hours an email should be triggered to every users with details of all the issues assigned to him/her. Here 24 hours should be configurable.(for e.g we may ask you to send emails for every 10 hours or even every 10 secs)