add Readme.md

This commit is contained in:
2020-12-16 16:09:21 +01:00
parent 359c733977
commit 1df1ae23ae
4 changed files with 35 additions and 43 deletions

6
.idea/vcs.xml generated Normal file
View File

@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="VcsDirectoryMappings">
<mapping directory="$PROJECT_DIR$" vcs="Git" />
</component>
</project>

View File

@@ -1,21 +0,0 @@
FROM node:lts-alpine
RUN mkdir -p /home/node/app/node_modules
WORKDIR /home/node/app
COPY package.json yarn.* ./
RUN apk add --no-cache git
COPY . /home/node/app/
RUN chown -R node:node /home/node
RUN yarn
USER node
EXPOSE 3333
ENTRYPOINT ["node","ace","serve","--watch"]

View File

@@ -1 +1,29 @@
# artapi
# ArtApi 🧠
ArtAPi is my personnal api connected to my instances
## Features ✨
- Likes system
- Location sharing
- Mail System
- Notification system with subscribers
## Tech used ⚙
- AdonisJs v5 (BackEnd)
- Redis (Caching)
- MariaDb (Storage)
## Usage 📚
- *soon*
## Author 👤
➡ Arthur Danjou : Developer
- Twitter : [@ArthurDanj](https://twitter.com/ArthurDanj)
- GitHub : [@ArthurDanjou](https://github.com/ArthurDanjou)
## License 📑
Copyright © 2020 - [@ArthurDanj](https://arthurdanjou.fr) \
This project is [MIT](https://github.com/ArthurDanjou/artapi/blob/master/License) Licensed.

View File

@@ -1,21 +0,0 @@
version: "3"
services:
mariadb:
image: mariadb
restart: always
environment:
MYSQL_ROOT_PASSWORD: password
MYSQL_USER: root
MYSQL_PASSWORD: password
MYSQL_DATABASE: artapi
adonisjs:
build:
context: .
dockerfile: Dockerfile
volumes:
- .:/home/node/app
- /home/node/app/node_modules
ports:
- 80:3333
depends_on:
- mariadb