prithwish10 / aucteria

A cloud-based serverless full featured bidding solution, which helps auction businesses manage the entire lifecycle of auctions using bidding as the bargaining alternative. It let users watch live sell-offs online and bid on auction markets in real-time.

Aucteria

Table of Contents

1. About The Project
   • Built With
   • Project Architecture
2. Getting Started
   • Prerequisites
3. Deployment
4. Contributing
5. Contact

About The Project

Aucteria is a cloud-based serverless full featured bidding solution, which helps auction businesses manage the entire lifecycle of auctions using bidding as the bargaining alternative. It let users watch live sell-offs online and bid on auction markets in real-time.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• Serverless
• Auth0
• 
• 
• 
• 
• 

(back to top)

Project Architecture

(back to top)

Getting Started

I'm working on Ubuntu 20.04

Prerequisites

• nodejs

  To get this version, you can use the apt package manager. Refresh your local package index first by typing:

  sudo apt update

  Then install Node.js:

  sudo apt install nodejs

  Check that the install was successful by querying node for its version number:

  node -v

• npm

  If the package in the repositories suits your needs, this is all you need to do to get set up with Node.js. In most cases, you’ll also want to install npm, the Node.js package manager. You can do this by installing the npm package with apt:

  sudo apt install npm

• Create an AWS Account, if you don't already have one

• AWS CLI

  To update or install the AWS CLI on your machine, you can refer to this amazing AWS documentation: https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html

  After install the AWS CLI on your machine, open the cmd and type aws. If you get something like this, then you are good to go:

  C:\Users\prith>aws                                                                                                                                                     usage: aws [options] <command> <subcommand> [<subcommand> ...] [parameters]                                             
  To see help text, you can run:
  aws help
  aws <command> help
  aws <command> <subcommand> help
  aws: error: the following arguments are required: command 

• Serverless framework

  Serverless framework comes with a pretty amaizing cmd. To install it, you can refer to this serverless framework documentation. I've used npm to install it, as it is really easy. https://www.serverless.com/framework/docs/getting-started

• Configure the AWS CLI

  Currently AWS or serverless don't know who you are. So you need to do the following steps:

  • Head over to your AWS developer console, and serach for the service IAM. This service handles permissions and users in AWS
  • Head over to Users from the left panel
  • Now you need to create a new user. Because it is not recommended to use your root AWS account.
    • Give your new user the Programmatic access and AWS Management Console access.
    • Create a strong password for this new user.
    • Attach Policies: You can give the AdmistratorAccess to your user, but in production built its recommended to give users permission to that many services that they require.
    • After creating the user, you will get an Access key ID and Secret access key. You will need those to configure the AWS CLI.
    • Head over to your cmd and type aws configure, and give the Access key ID and Secret access key, along with the aws region and serverless.yaml file format.

      C:\Users\prith>aws configure
      AWS Access Key ID [****************YSHX]: <ACCESS KEY ID>
      AWS Secret Access Key [****************DXmb]: <SECRET ACCESS KEY>
      Default region name [us-east-1]: <REGION>
      Default output format [yaml]: <FORMAT OF YOUR serverless.yml file. Give yaml>

    • Now log out from your AWS developer console and sign-in with the new username and password that you just created

(back to top)

Deployment

In order to deploy a stack, open your cmd and cd to the service that you want to deploy, and enter the following command:

cd auth_service
sls deploy

This will deploy the service on the default stage (i.e., dev) specified on serverless.yml file.

You can also deploy the service on any particular stage using the following command:

sls deploy --stage prod

If you have made changes to a specific lambda function,in that case you don't want to redeploy the entire stack, but what you want is to deploy that specific lambda function in which you have made the changes. For that use the following command:

sls deploy -f <FUNCTION_NAME>

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Name - Prithwish Das

Project Link: https://github.com/Prithwish10/Aucteria

LinkedIn: https://www.linkedin.com/in/prithwishdas60/

(back to top)