Skip to content

anthonyftwang/argotique

Repository files navigation

argotique

GitHub Actions Code Climate maintainability GitHub issues Website Docs Style

The dictionary of everyday French: Share and discuss useful expressions and slang.

🌐 Live at argotique.net

📖 Interactive docs here

🛠 Built with React, GraphQL, & AWS Amplify (ft. Lambda, S3, DynamoDB, AppSync, & Cognito)

Features

  • 🗣️ Submit, edit and delete argots
  • 🔍 Sort argots and find them by author
  • ❤️ Like argots and access them later
  • 💬 Submit comments to discuss argots
  • 👮‍ Authenticated + sign up confirmation
  • 📱 Responsive design for web + mobile
  • 🚀 Serverless back end + GraphQL

Quick Start

Deploy the back end with AWS

  1. Clone the repo & install the dependencies
~ git clone https://github.com/anthonyftwang/argotique.git
~ cd argotique
~ npm install
  1. Initialize and deploy the Amplify project
~ amplify init
? Enter a name for the environment: dev (or whatever you would like to call this env)
? Choose your default editor: <YOUR_EDITOR_OF_CHOICE>
? Do you want to use an AWS profile? Y

~ amplify push
? Are you sure you want to continue? Y
? Do you want to generate code for your newly created GraphQL API? N
> We already have the GraphQL code generated for this project, so generating it here is not necessary.
  1. Start the app and register a new user
~ yarn start

Build the front end

  1. Clone the repository and run npm install
  2. Run npm start to host the site locally
  3. Run npx styleguidist server to host the docs locally

Deploy the front end

  1. Create a new repository with your git service of choice

  2. Push the project to your new repository

~ git remote add origin <your_new_repository>
~ git push --set-upstream master
  1. Connect to AWS Amplify Console to set up continuous deployments. C'est parti!

About

The dictionary of everyday French: Share and discuss useful expressions and slang.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •